Javascript: CommentedText.setHighlightColor Method

Description

Sets the highlight color for the comment. Accepts CSS color strings.

Syntax

<void> CommentedText.setHighlightColor(<string> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
value	The property value.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates CommentedText.setHighlightColor in a practical document-editing workflow. It sets the highlight color for the comment. Accepts CSS color strings.

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

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