Description

Gets the index (one-based) of the first character which belongs to the table of contents.

Syntax

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

Parameters

Parameter	Description
callback	Receives the property value.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TableOfContents.getStart in a practical document-editing workflow. It gets the index (one-based) of the first character which belongs to the table of contents.

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

function inspectStart(tableOfContents) {
    tableOfContents.getStart(
        function(result) {
            console.log("get start result:", result);
        },
        onTxError
    );
}