Add Method (TablesOfFigures Collection)

See Also         Example         Applies To

Adds a table of figures to a document.

Syntax

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

expression   Required. An expression that returns a TablesOfFigures object.

Range   Required Range. The range where you want the table of figures to appear.

Caption   Optional Variant. The label that identifies the items you want to include in the table of figures. Corresponds to the \c switch for a TOC (Table of Contents) field. The default value is "Figure."

IncludeLabel   Optional Variant. True to include the caption label and caption number in the table of figures. The default value is True.

UseHeadingStyles   Optional Variant. True to use built-in heading styles to create the table of figures. The default value is False.

UpperHeadingLevel   Optional Variant. The starting heading level for the table of figures, if UseHeadingStyles is set to True. 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 figures, if UseHeadingStyles is set to True. 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 to use TC (Table of Contents Entry) fields to create the table of figures. Use the MarkEntry method to mark entries you want to include in the table of figures. The default value is False.

TableId   Optional Variant. A one-letter identifier that's used to build a table of figures from TC (Table of Contents Entry) fields. Corresponds to the \f switch for a TOC (Table of Contents) field. For example, "i" builds a table of figures for an illustration.

RightAlignPageNumbers   Optional Variant. True align page numbers with the right margin in the table of figures. The default value is True.

IncludePageNumbers   Optional Variant. True if page numbers are included in the table of figures. The default value is True.

AddedStyles   Optional Variant. The sting name for additional styles used to compile the table of figures (styles other than the Heading 1 – Heading 9 styles). Use the Add method to create new heading styles.

UseHyperlinks   Optional Variant. True if entries in a table of figures should be formatted as hyperlinks when publishing to the Web. The default value is True.

HidePageNumbersInWeb   Optional Variant. True if page numbers in a table of figures should be hidden when publishing to the Web. The default value is True.