Description

Relates a user-defined name to a subtextpart.

Syntax

<void> SubTextPart.getName(<RequestStringCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives the name.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates SubTextPart.getName in a practical document-editing workflow. Relates a user-defined name to 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.getName(
            function(result) {
                console.log("get name result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);