Description

Sets a value indicating whether all the footnote numbers, reference marks as well as footnote marks, in the document are highlighted.

Syntax

<void> FootnoteCollection.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 FootnoteCollection.setHighlightMode in a practical document-editing workflow. It sets a value indicating whether all the footnote numbers, reference marks as well as footnote marks, in the document are highlighted.

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

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