DS Server

Javascript: TableOfContents.getHighlightMode Method

Method|Introduced in 29.0

Description

Gets a value indicating whether the table of contents is highlighted.

Syntax

<void> TableOfContents.getHighlightMode(<RequestNumberCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the property value.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TableOfContents.getHighlightMode in a practical document-editing workflow. It gets a value indicating whether the table of contents is highlighted.

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

function inspectHighlightMode(tableOfContents) {
    tableOfContents.getHighlightMode(
        function(result) {
            console.log("get highlight mode result:", result);
        },
        onTxError
    );
}