docx
    Preparing search index...

    Class TableOfContents

    Represents a Table of Contents in a WordprocessingML document.

    TableOfContents creates an auto-generated list of document headings with page numbers. It uses a TOC field code to generate entries.

    Unless it is given cachedEntries or contentChildren, it is written with an entry for each heading its options include, linked to a bookmark on the heading, so it isn't empty before Word updates it or in applications that don't update it. The page numbers are left for Word to fill in when it updates the field, unless the document's pageNumbers writes them.

    Reference: http://officeopenxml.com/WPtableOfContents.php

    <xsd:complexType name="CT_SdtBlock">
      <xsd:sequence>
        <xsd:element name="sdtPr" type="CT_SdtPr" minOccurs="0"/>
        <xsd:element name="sdtEndPr" type="CT_SdtEndPr" minOccurs="0"/>
        <xsd:element name="sdtContent" type="CT_SdtContentBlock" minOccurs="0"/>
      </xsd:sequence>
    </xsd:complexType>

    new TableOfContents("Contents", {
      hyperlink: true,
      headingStyleRange: "1-3",
    });

    Hierarchy (View Summary)

    Index
    constructor
    fileChild
    writtenAs
    addChildElement prepForXml

    • Parameters

      • alias: string = "Table of Contents"
      • __namedParameters: ITableOfContentsOptions & {
            beginDirty?: boolean;
            cachedEntries?: readonly ToCEntry[];
            contentChildren?: readonly (string | XmlComponent)[];
        } = {}
        • Optional ReadonlybeginDirty?: boolean

          Whether the field is written dirty, so Word updates the table when it opens the document, after asking to. Default is dirty, unless the document is given pageNumbers: then it is written clean, so Word shows it as it is written, and doesn't ask.

        • Optional ReadonlycachedEntries?: readonly ToCEntry[]

          Use this to provide pre-generated entries for the Table of Contents.

          Note that indentation should come from the paragraph styles defined on the document. By default the styles are TOC1, TOC2, etc. These can be overridden with stylesWithLevels (\t)

        • Optional ReadonlycontentChildren?: readonly (string | XmlComponent)[]

      Returns TableOfContents

    fileChild: symbol = ...

    Marker property identifying this as a FileChild

    • get writtenAs(): readonly BaseXmlComponent[] | undefined
      Internal

      The components written in this one's place, one after another, when it can't be written as a single element, such as a run with another run in its children. Undefined when it is written as itself.

      Returns readonly BaseXmlComponent[] | undefined

    Settings
    Member Visibility

    On This Page
    XSD Schema
    Constructors
    Properties
    Accessors
    Methods