TX Text Control .NET Server

Javascript: SubTextPart.setID Method

Method|Introduced in 28.0

Description

Sets an identifier for the subtextpart.

Syntax

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

Parameters

ParameterDescription
id

An identifier for the 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.setID in a practical document-editing workflow. It sets an identifier for the 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.setID(
            25,
            function() {
                console.log("set id completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);