DS Server

Javascript: TableOfContents.setName Method

Method|Introduced in 29.0

Description

Sets a name for the table of contents.

Syntax

<void> TableOfContents.setName(<string> 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.setName in a practical document-editing workflow. It sets a name for the table of contents.

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

function configureName(tableOfContents) {
    tableOfContents.setName(
        "Quarterly report",
        function() {
            console.log("set name completed.");
        },
        onTxError
    );
}