TXTextControl.TextFieldEventArgs Object

The event argument object for text field related events. (e. g. the textFieldClicked event)

Introduced: 23.0.

Syntax

[JavaScript]
{
    fieldType: <string>    // "APPLICATIONFIELD" / "TEXTFIELD",
    fieldName: <string>,
    typeName: <string>,    // null / "MERGEFIELD" / "DATE" / "NEXTIF" etc.,
    start: <integer>,
    length: <integer>,
    id: <integer>,
    parameters: <string[]>
}

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.
fieldName The field's name.
fieldText The text which is contained within a text field.
fieldType The field type ("APPLICATIONFIELD" or "TEXTFIELD").
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.
parameters A string array of the field's parameters, if fieldType is "APPLICATIONFIELD".
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.
typeName The merge field type in case of field type "APPLICATIONFIELD" ("MERGEFIELD", "DATE", "NEXTIF" etc.).

See Also