DS Server

TextField Object

Object|Introduced in 25.0

Description

Represents a text field in a Text Control document. A text field is a marked piece of text that has properties like text or a name.

Syntax

TXTextControl.TextField

Examples

The following example demonstrates TXTextControl.TextField in a practical document-editing workflow. It represents a text field in a Text Control document. A text field is a marked piece of text that has properties like text or a name.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

function inspectTextField(textField) {
    textField.getID(
        function(result) {
            console.log("get id result:", result);
        },
        onTxError
    );
}

Members

Constructors

Constructor	Description
TextField	Initializes a new instance of the TextField class.

Properties

Property	Description
bounds	Obsolete. This property will be removed in one of the next versions. The bounding rectangle of a text field. The bounding rectangle is the smallest rectangle which contains all characters of the field's text.
containsInputPosition	Obsolete. This property will be removed in one of the next versions. Returns true if the Textfield contains the current text input position.
deleteable	Obsolete. This property will be removed in one of the next versions. Specifies whether a text field can be deleted by the end-user while a TX Text Control document is being edited.
doubledInputPosition	Obsolete. This property will be removed in one of the next versions. Specifies whether a text field has a doubled input position in front of its first character and behind its last character.
editable	Obsolete. This property will be removed in one of the next versions. 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	Obsolete. This property will be removed in one of the next versions. The identifier of the text field.
isSpellCheckingEnabled	Obsolete. This property will be removed in one of the next versions. Specifies whether a text field's text is checked on misspelled words.
length	Obsolete. This property will be removed in one of the next versions. The number of characters in the text field.
name	Obsolete. This property will be removed in one of the next versions. The Text field's name.
showActivated	Obsolete. This property will be removed in one of the next versions. Specifies whether a text field toggles its background to gray, if the current input position is in the field.
start	Obsolete. This property will be removed in one of the next versions. The 1-based first character position of the text field.
text	Obsolete. This property will be removed in one of the next versions. The Text field's text.
type	Obsolete. This property will be removed in one of the next versions. The field type ("APPLICATIONFIELD" or "TEXTFIELD").