Description

Sets the highlight color for the tracked change.

Syntax

<void> TrackedChange.setHighlightColor(<string> highlightColor, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
highlightColor	Highlight color for the tracked change.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TrackedChange.setHighlightColor in a practical document-editing workflow. It sets the highlight color for the tracked change.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.textParts.getMainText(function(mainText) {
    const trackedChanges = mainText.trackedChanges;
    trackedChanges.getItem(function(trackedChange) {
        if (!trackedChange) {
            console.warn("No tracked change is available at the current input position.");
            return;
        }
    
        trackedChange.setHighlightColor(
            "#ffd54f",
            function() {
                console.log("set highlight color completed.");
            },
            onTxError
        );
    }, onTxError);
}, onTxError);