Description

The method parameters for the TableOfContentsCollection.add() method.

Syntax

{
   [title: <string>],
   [hasLinks: <boolean>],
   [hasPageNumbers: <boolean>],
   [hasRightAlignedPageNumbers: <boolean>],
   [minimumStructureLevel: <number>],
   [maximumStructureLevel: <number>]
}

Examples

The following example demonstrates TableOfContentsCollectionAddParams in a practical document-editing workflow. The method parameters for the TableOfContentsCollection.add() method.

function inspectTableOfContentsCollectionAddParams(tableOfContentsCollectionAddParams) {
    console.log("title:", tableOfContentsCollectionAddParams.title);
    console.log("has links:", tableOfContentsCollectionAddParams.hasLinks);
    console.log("has page numbers:", tableOfContentsCollectionAddParams.hasPageNumbers);
    console.log("has right aligned page numbers:", tableOfContentsCollectionAddParams.hasRightAlignedPageNumbers);
}

Members

Properties

Property	Description
hasLinks	Optional. Specifies whether each entry in the table of contents is a DocumentLink with a corresponding DocumentTarget.
hasPageNumbers	Optional. Specifies whether the table of contents contains page numbers.
hasRightAlignedPageNumbers	Optional. Specifies whether the page numbers in the table of contents are right-aligned.
maximumStructureLevel	Optional. The minimum structure level for this table of contents.
minimumStructureLevel	Optional. The maximum structure level for this table of contents.
title	Optional. The title for the table of contents.