Class TableOfFigures (Word VBA)

The class TableOfFigures represents a single table of figures in a document. The TableOfFigures object is a member of the TablesOfFigures collection. The TablesOfFigures collection includes all the tables of figures in a document.

To use a TableOfFigures class variable it first needs to be instantiated, for example

Dim tofs as TableOfFigures
Set tofs = ActiveDocument.TablesOfFigures(Index:=1)

The following procedures can be used to set variables of type TableOfFigures: TablesOfFigures.Add and TablesOfFigures.Item.

For Each

Here is an example of processing the TableOfFigures items in a collection.

Dim tof As TableOfFigures 
For Each tof In Documents("Sales.docx").TablesOfFigures 
 tof.UpdatePageNumbers 
Next tof

Methods

Delete - Deletes the specified table of figures.

Update - Updates the entries shown in a table of figures.

UpdatePageNumbers - Updates the page numbers for items in a table of figures.

Properties

Caption returns or sets the label that identifies the items to be included in a table of figures.

HeadingStyles returns a HeadingStyles object that represents additional styles used to compile a table of contents or table of figures (styles other than the Heading 1 - Heading 9 styles).

HidePageNumbersInWeb returns or sets whether page numbers in a table of contents or a table of figures should be hidden when publishing to the Web.

IncludeLabel true if the caption label and caption number are included in a table of figures.

IncludePageNumbers true if page numbers are included in the table of figures.

LowerHeadingLevel returns or sets the ending heading level for a table of figures.

Range returns a Range object that represents the portion of a document that is contained within the specified table of figures.

RightAlignPageNumbers true if page numbers are aligned with the right margin in an table of figures.

TabLeader returns or sets the character between entries and their page numbers in an table of figures.

TableID returns or sets a one-letter identifier that is used to build a table of figures from TOC fields.

UpperHeadingLevel returns or sets the starting heading level for a table of figures.

UseFields true if Table of Contents Entry (TC) fields are used to create a table of figures.

UseHeadingStyles true if built-in heading styles are used to create a table of figures.

UseHyperlinks returns or sets whether entries in a table of figures should be formatted as hyperlinks when publishing to the Web.

HeadingStyles - A collection of HeadingStyle objects that represent the styles used to compile a table of figures or table of contents.

Range - Represents a contiguous area in a document. Each Range object is defined by a starting and ending character position.