Description

Sets the name of a document target.

Syntax

<void> DocumentTarget.setName(<string> name, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
name	Relates a user-defined name to 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.setName in a practical document-editing workflow. It sets the name of a 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.setName(
            "InvoiceDetails",
            function() {
                console.log("set name completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);