Description

Sets the name of the document target.

Syntax

<void> DocumentTarget.setTargetName(<string> targetName, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
targetName	The document target's name.
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.setTargetName in a practical document-editing workflow. It sets the name of 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.setTargetName(
            "InvoiceDetails",
            function() {
                console.log("set target name completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);