GetText Function (DynamicText StaticText TextField)

Class

DynamicText, StaticText, and TextField.

Action

Returns the text of the text field.

Syntax

sText = object.GetText ([iStartChar, iNumChars])
Variable Description
sText The returned text. STRING.
iStartChar Optional. The position in the string (starting from 1) of the first character to return. INTEGER.
iNumChars Optional. The number of characters to return. INTEGER.

Notes

GetText returns the text from the dynamic text, static text, or single-line text field. It returns only the first line of a multi-line text field.

  • If you include iStartChar but not iNumChars, GetText returns the text from the iStartChar character to the end of the text.

  • If you include both arguments, GetText returns iNumChars characters, starting with the iStartChar character.

Example

STRING sAllText
sAllText = GotoLine.Line.GetText()
Parent topic: DynamicText Class
Parent topic: StaticText Class
Parent topic: TextField Class