Javascript: Footnote.setHighlightMode Method

Description

Sets a value indicating whether the reference mark and the footnote mark is highlighted.

Syntax

<void> Footnote.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 Footnote.setHighlightMode in a practical document-editing workflow. It sets a value indicating whether the reference mark and the footnote mark is highlighted.

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

TXTextControl.footnotes.elementAt(0, function(footnote) {
    if (!footnote) {
        console.warn("No footnote is available.");
        return;
    }

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