Javascript: CommentedText.getHighlightMode Method

Description

Gets a value indicating whether the comment is highlighted.

Syntax

<void> CommentedText.getHighlightMode(<RequestHighlightModeCallback> callback, [<ErrorCallback> errorCallback])

Parameters

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

Examples

The following example demonstrates CommentedText.getHighlightMode in a practical document-editing workflow. It gets 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.getHighlightMode(
            function(result) {
                if (!result) {
                    console.warn("No highlight mode was returned.");
                    return;
                }
                
                console.log("get highlight mode result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);