TX Text Control .NET Server

Javascript: TextField.getDeleteable Method

Method|Introduced in 28.0

Description

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

Syntax

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

Parameters

ParameterDescription
callback

Receives whether a text field can be deleted.

errorCallback

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

Examples

The following example demonstrates TextField.getDeleteable in a practical document-editing workflow. It gets whether a text field can be deleted 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 inspectDeleteable(textField) {
    textField.getDeleteable(
        function(result) {
            if (result) {
                console.log("get deleteable is available.");
            } else {
                console.warn("get deleteable is not available in the current document state.");
            }
        },
        onTxError
    );
}