Description

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

Syntax

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

Parameters

Parameter	Description
callback	Receives whether a document target can be deleted.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates DocumentTarget.getDeleteable in a practical document-editing workflow. It gets whether a document target 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;
}

TXTextControl.textParts.getMainText(function(mainText) {
    const documentTargets = mainText.documentTargets;
    documentTargets.getItem(function(documentTarget) {
        if (!documentTarget) {
            console.warn("No document target is available at the current input position.");
            return;
        }
    
        documentTarget.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
        );
    }, onTxError);
}, onTxError);