DS Server

Javascript: TextField.getContainsInputPosition Method

Method|Introduced in 28.0

Description

Returns true, if the Textfield contains the current text input position.

Syntax

<void> TextField.getContainsInputPosition(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives whether the TextField contains the current text input position.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TextField.getContainsInputPosition in a practical document-editing workflow. It returns true, if the Textfield contains the current text input position.

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

function inspectContainsInputPosition(textField) {
    textField.getContainsInputPosition(
        function(result) {
            if (result) {
                console.log("get contains input position is available.");
            } else {
                console.warn("get contains input position is not available in the current document state.");
            }
        },
        onTxError
    );
}