Description

Gets whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited.

Syntax

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

Parameters

Parameter	Description
callback	Receives whether the text of a text field can be changed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TextField.getEditable in a practical document-editing workflow. It gets whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited.

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

function inspectEditable(textField) {
    textField.getEditable(
        function(result) {
            if (result) {
                console.log("get editable is available.");
            } else {
                console.warn("get editable is not available in the current document state.");
            }
        },
        onTxError
    );
}