Description

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

Syntax

<void> DocumentTarget.setDeleteable(<boolean> deleteable, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
deleteable	Specifies whether a document target can be deleted by the end-user while a TX Text Control document is being edited.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates DocumentTarget.setDeleteable in a practical document-editing workflow. It sets 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.setDeleteable(
            true,
            function() {
                console.log("set deleteable completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);