Description

Sets an identifier for the document target.

Syntax

<void> DocumentTarget.setID(<number> id, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
id	An identifier for the document target.
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.setID in a practical document-editing workflow. It sets an identifier for the document target.

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.setID(
            25,
            function() {
                console.log("set id completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);