Description

Sets a value indicating when the subtextpart is highlighted.

Syntax

<void> SubTextPart.setHighlightMode(<HighlightMode> highlightMode, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
highlightMode	Indicates when the subtextpart is highlighted.
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.setHighlightMode in a practical document-editing workflow. It sets a value indicating when the subtextpart is highlighted.

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.setHighlightMode(
            TXTextControl.HighlightMode.Always,
            function() {
                console.log("set highlight mode completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);