Javascript: SubTextPart.setName Method

Description

Sets the name of a subtextpart.

Syntax

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

Parameters

Parameter	Description
name	Relates a user-defined name to a subtextpart.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates SubTextPart.setName in a practical document-editing workflow. It sets the name of a subtextpart.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.textParts.getMainText(function(mainText) {
    const subTextParts = mainText.subTextParts;
    subTextParts.getItem(function(subTextPart) {
        if (!subTextPart) {
            console.warn("No sub text part is available at the current input position.");
            return;
        }
    
        subTextPart.setName(
            "InvoiceAddress",
            function() {
                console.log("set name completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);