TablesOfContents.Add Method

  • Article
Word Developer Reference

Returns a TableOfContents object that represents a table of contents added to a document.

Syntax

expression.Add(Range, UseHeadingStyles, UpperHeadingLevel, LowerHeadingLevel, UseFields, TableID, RightAlignPageNumbers, IncludePageNumbers, AddedStyles, UseHyperlinks, HidePageNumbersInWeb, UseOutlineLevels)

expression   Required. A variable that represents a TablesOfContents collection.

Parameters

Name Required/Optional Data Type Description
Range Required Range object The range where you want the table of contents to appear. The table of contents replaces the range, if the range isn't collapsed.
UseHeadingStyles Optional Variant True to use built-in heading styles to create the table of contents. The default value is True.
UpperHeadingLevel Optional Variant The starting heading level for the table of contents. Corresponds to the starting value used with the \o switch for a Table of Contents (TOC) field. The default value is 1.
LowerHeadingLevel Optional Variant The ending heading level for the table of contents. Corresponds to the ending value used with the \o switch for a Table of Contents (TOC) field. The default value is 9.
UseFields Optional Variant True if Table of Contents Entry (TC) fields are used to create the table of contents. Use the MarkEntry method to mark entries to be included in the table of contents. The default value is False.
TableID Optional Variant A one-letter identifier that's used to build a table of contents from TC fields. Corresponds to the \f switch for a Table of Contents (TOC) field. For example, "T" builds a table of contents from TC fields using the table identifier T. If this argument is omitted, TC fields aren't used.
RightAlignPageNumbers Optional Variant True if page numbers in the table of contents are aligned with the right margin. The default value is True.
IncludePageNumbers Optional Variant True to include page numbers in the table of contents. The default value is True.
AddedStyles Optional Variant The string name for additional styles used to compile the table of contents (styles other than the Heading 1 – Heading 9 styles). Use the Add method of a HeadingStyles object to create new heading styles.
UseHyperlinks Optional Variant True if entries in a table of contents should be formatted as hyperlinks when the document is being publishing to the Web. The default value is True.
HidePageNumbersInWeb Optional Variant True if page numbers in a table of contents should be hidden when the document is being publishing to the Web. The default value is True.
UseOutlineLevels Optional Variant True to use outline levels to create the table of contents. The default is False.

Return Value
TableOfContents

Example

This example adds a table of contents at the beginning of the active document. The table of contents is built from paragraphs styled with the Heading 1, Heading 2, and Heading 3 styles or the custom styles myStyle and yourStyle.

Visual Basic for Applications 
  Set myRange = ActiveDocument.Range(0, 0)
ActiveDocument.TablesOfContents.Add _
    Range:=myRange, _
    UseFields:=False, _
    UseHeadingStyles:=True, _
    LowerHeadingLevel:=3, _
    UpperHeadingLevel:=1, _
    AddedStyles:="myStyle, yourStyle"

See Also