Description

Sets a value indicating whether the comment is highlighted.

Syntax

<void> CommentedText.setHighlightMode(<HighlightMode> 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.setHighlightMode in a practical document-editing workflow. It sets a value indicating whether the comment is highlighted.

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