Description

Contains all standard text fields in a Text Control document or part of the document.

Syntax

TextFieldCollectionBase

Examples

The following example demonstrates TextFieldCollectionBase in a practical document-editing workflow. It contains all standard text fields in a Text Control document or part of the document.

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

function inspectTextFieldCollectionBase(textFieldCollectionBase) {
    textFieldCollectionBase.getCanAdd(
        function(result) {
            if (result) {
                console.log("get can add is available.");
            } else {
                console.warn("get can add is not available in the current document state.");
            }
        },
        onTxError
    );
}

Members

Methods

Method	Description
elementAt	Returns the element at a specified index in the collection. (Inherited from Collection.)
forEach	Executes a callback function for each element. (Inherited from Collection.)
getCanAdd	Gets a value indicating whether a new text field can be inserted at the current input position.
getCount	Gets the number of elements contained in the collection. (Inherited from Collection.)