TXTextControl.TextField Object

Represents a Text Control TextField. Is used as the callback function argument for the getTextFields method and as a parameter for the addTextField method, for example.

Introduced: 25.0.

Syntax

[JavaScript]
{
    text: <string>,
    name: <string>,
    start: <integer>,
    length: <integer>,
    id: <integer>,
    type: <string>,	// "APPLICATIONFIELD" or "TEXTFIELD"
    bounds: <Rectanlge>,
    containsInputPosition: <boolean>,
    deleteable: <boolean>,
    doubledInputPosition: <boolean>,
    editable: <boolean>,
    showActivated: <boolean>,
    isSpellCheckingEnabled: <boolean>,
}

Properties

Property Description
bounds The bounding rectangle of a text field.
containsInputPosition Returns true if the Textfield contains the current text input position.
deleteable Specifies whether a text field can be deleted by the end-user while a TX Text Control document is being edited.
doubledInputPosition Specifies whether a text field has a doubled input position in front of its first character and behind its last character.
editable Specifies whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited.
id The identifier of the text field.
isSpellCheckingEnabled Specifies whether a text field's text is checked on misspelled words.
length The number of characters in the text field.
name The text field's name.
showActivated Specifies whether a text field toggles its background to gray, if the current input position is in the field.
start The 1-based first character position of the text field.
text The Text field's text.
type The field type ("APPLICATIONFIELD" or "TEXTFIELD").

See Also