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.

    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

    Constructors

    constructor

    Properties

    fileChild

    Methods

    addChildElement prepForXml

    Constructors

    • Parameters

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

    Properties

    fileChild: symbol = ...

    Marker property identifying this as a FileChild

    Methods

    • Prepares this component and its children for XML serialization.

      This method is called by the Formatter to convert the component tree into an object structure compatible with the xml library (https://www.npmjs.com/package/xml). It recursively processes all children and handles special cases like attribute-only elements and empty elements.

      The method can be overridden by subclasses to customize XML representation or execute side effects during serialization (e.g., creating relationships).

      Parameters

      • context: IContext

        The serialization context containing document state

      Returns IXmlableObject | undefined

      The XML-serializable object, or undefined to exclude from output

      // Override to add custom serialization logic
      prepForXml(context: IContext): IXmlableObject | undefined {
        // Custom logic here
        return super.prepForXml(context);
      }

    Settings

    Member Visibility

    On This Page

    XSD Schema
    Constructors
    Properties
    Methods