Description

Sets the global comment highlight mode.

Syntax

<void> TXTextControl.setCommentHighlightMode(<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 TXTextControl.setCommentHighlightMode in a practical document-editing workflow. It sets the global comment highlight mode.

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

TXTextControl.setCommentHighlightMode(
    TXTextControl.HighlightMode.Always,
    function() {
        console.log("set comment highlight mode completed.");
    },
    onTxError
);