DlgScrollingText.AppendLine

OverviewExamples

DlgScrollingText.AppendLine (

number ControlID,

string Line = "",

boolean AddNewLine = true,

boolean ScrollToEnd = true )

Description

Appends a new line to the current text in a scrolling text control.

Note: This action only works when the Scrolling Text control is in Text mode.

Note: This action will only work if called from a screen's events and if the named control is on the current screen.

Parameters

ControlID

(number) The numeric ID of the scrolling text control that you want to add a new line to.

Line

(string) The line of text you want to add.

AddNewLine

(boolean) Whether to add the text on a new line in the scrolling text window:

VALUE	DESCRIPTION
true	Add the text on a new line. (Default)
false	Append the new text to the last line.

ScrollToEnd

(boolean) Whether to scroll to the end of the text window after the text has been added:

VALUE	DESCRIPTION
true	Scroll to the end. (Default)
false	Keep the text window at its current position.

Returns

Nothing. If the current screen does not contain the control, this action will fail. You can use Application.GetLastError to determine whether this action failed, and why.