Description

Sets a value indicating whether the editable region is highlighted.

Syntax

<void> EditableRegion.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 EditableRegion.setHighlightMode in a practical document-editing workflow. It sets a value indicating whether the editable region is highlighted.

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

function configureHighlightMode(editableRegion) {
    editableRegion.setHighlightMode(
        TXTextControl.HighlightMode.Always,
        function() {
            console.log("set highlight mode completed.");
        },
        onTxError
    );
}