DS Server

Javascript: TableOfContents.setHasLinks Method

Method|Introduced in 29.0

Description

Sets a value specifying whether each entry in the table of contents is a DocumentLink with a corresponding DocumentTarget.

Syntax

<void> TableOfContents.setHasLinks(<boolean> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
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 TableOfContents.setHasLinks in a practical document-editing workflow. It sets a value specifying whether each entry in the table of contents is a DocumentLink with a corresponding DocumentTarget.

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

function configureHasLinks(tableOfContents) {
    tableOfContents.setHasLinks(
        true,
        function() {
            console.log("set has links completed.");
        },
        onTxError
    );
}