Add Method (TablesOfContents Collection)

See Also         Example         Applies To

Adds a table of contents to a document.

Syntax

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

expression   Required. An expression that returns a TablesOfContents object.

Range   Required Range. 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 TOC (Table of Contents) 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 TOC (Table of Contents) field. The default value is 9.

UseFields   Optional Variant. True if TC (Table of Contents Entry) 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 TOC (Table of Contents) 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.