Javascript: Footnote.setHighlightColor Method

Description

Sets the highlight color for the reference mark and the footnote mark.

Syntax

<void> Footnote.setHighlightColor(<string> 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.setHighlightColor in a practical document-editing workflow. It sets the highlight color for the reference mark and the footnote mark.

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.setHighlightColor(
        "#ffd54f",
        function() {
            console.log("set highlight color completed.");
        },
        onTxError
    );
}, onTxError);