Description

Sets the highlight color for the subtextpart.

Syntax

<void> SubTextPart.setHighlightColor(<String> highlightColor, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
highlightColor	The highlight color 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.setHighlightColor in a practical document-editing workflow. It sets the highlight color 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.setHighlightColor(
            "#ffd54f",
            function() {
                console.log("set highlight color completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);