Javascript: TextField.setHighlightMode Method - TX Text Control DS Server

TX Text Control DS ServerReference GuideJavaScript APITextField ObjectsetHighlightMode Method

Sets a value indicating when the text field is highlighted.

JavaScript

<void> TextField.setHighlightMode(<HighlightMode> highlightMode, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
highlightMode	Indicates when the text field is highlighted.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example shows how to set the highLightMode for all applicationField objects in every textPart object in the current document.

JavaScript

function changeHighlightMode(){
    TXTextControl.textParts.forEach(textPart => {
        textPart.applicationFields.forEach(appField => {
            appField.setHighlightMode(TXTextControl.HighlightMode.Activated);
        });
    });
}