DS Server

Javascript: SubTextPart.getOuterSubTextPart Method

Method|Introduced in 28.0

Description

Gets a subtextpart's outer subtextpart.

Syntax

<void> SubTextPart.getOuterSubTextPart(<RequestSubTextPartCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the subtextpart's outer subtextpart.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates SubTextPart.getOuterSubTextPart in a practical document-editing workflow. It gets a subtextpart's outer 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.getOuterSubTextPart(
            function(subTextPart) {
                if (!subTextPart) {
                    console.warn("No sub text part was returned.");
                    return;
                }
                
                console.log("get outer sub text part result:", subTextPart);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);