TablesOfFigures.Add Method

Returns a TableOfFigures object that represents a table of figures added to a document.

Namespace:  Microsoft.Office.Interop.Word
Assembly:  Microsoft.Office.Interop.Word (in Microsoft.Office.Interop.Word.dll)

Syntax

'Declaration
Function Add ( _
    Range As Range, _
    ByRef Caption As Object, _
    ByRef IncludeLabel As Object, _
    ByRef UseHeadingStyles As Object, _
    ByRef UpperHeadingLevel As Object, _
    ByRef LowerHeadingLevel As Object, _
    ByRef UseFields As Object, _
    ByRef TableID As Object, _
    ByRef RightAlignPageNumbers As Object, _
    ByRef IncludePageNumbers As Object, _
    ByRef AddedStyles As Object, _
    ByRef UseHyperlinks As Object, _
    ByRef HidePageNumbersInWeb As Object _
) As TableOfFigures
'Usage
Dim instance As TablesOfFigures
Dim Range As Range
Dim Caption As Object
Dim IncludeLabel As Object
Dim UseHeadingStyles As Object
Dim UpperHeadingLevel As Object
Dim LowerHeadingLevel As Object
Dim UseFields As Object
Dim TableID As Object
Dim RightAlignPageNumbers As Object
Dim IncludePageNumbers As Object
Dim AddedStyles As Object
Dim UseHyperlinks As Object
Dim HidePageNumbersInWeb As Object
Dim returnValue As TableOfFigures

returnValue = instance.Add(Range, Caption, _
    IncludeLabel, UseHeadingStyles, _
    UpperHeadingLevel, LowerHeadingLevel, _
    UseFields, TableID, RightAlignPageNumbers, _
    IncludePageNumbers, AddedStyles, _
    UseHyperlinks, HidePageNumbersInWeb)

TableOfFigures Add(
    Range Range,
    ref Object Caption,
    ref Object IncludeLabel,
    ref Object UseHeadingStyles,
    ref Object UpperHeadingLevel,
    ref Object LowerHeadingLevel,
    ref Object UseFields,
    ref Object TableID,
    ref Object RightAlignPageNumbers,
    ref Object IncludePageNumbers,
    ref Object AddedStyles,
    ref Object UseHyperlinks,
    ref Object HidePageNumbersInWeb
)

Parameters

• Range
  Type: Microsoft.Office.Interop.Word.Range
  Required Range object. The range where you want the table of figures to appear.

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

• IncludeLabel
  Type: System.Object%
  Optional Object. True to include the caption label and caption number in the table of figures. The default value is True.

• UseHeadingStyles
  Type: System.Object%
  Optional Object. True to use built-in heading styles to create the table of figures. The default value is False.

• UpperHeadingLevel
  Type: System.Object%
  Optional Object. 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 Table of Contents (TOC) field. The default value is 1.

• LowerHeadingLevel
  Type: System.Object%
  Optional Object. 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 Table of Contents (TOC) field. The default value is 9.

• UseFields
  Type: System.Object%
  Optional Object. True to use Table of Contents Entry (TC) 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
  Type: System.Object%
  Optional Object. A one-letter identifier that's used to build a table of figures from Table of Contents Entry (TC) fields. Corresponds to the \f switch for a Table of Contents (TOC) field. For example, "i" builds a table of figures for an illustration.

• RightAlignPageNumbers
  Type: System.Object%
  Optional Object. True align page numbers with the right margin in the table of figures. The default value is True.

• IncludePageNumbers
  Type: System.Object%
  Optional Object. True if page numbers are included in the table of figures. The default value is True.

• AddedStyles
  Type: System.Object%
  Optional Object. The string name for additional styles used to compile the table of figures (styles other than the Heading 1 – Heading 9 styles).

• UseHyperlinks
  Type: System.Object%
  Optional Object. True if entries in a table of figures should be formatted as hyperlinks when publishing to the Web. The default value is True.

• HidePageNumbersInWeb
  Type: System.Object%
  Optional Object. True if page numbers in a table of figures should be hidden when publishing to the Web. The default value is True.

Return Value

Type: Microsoft.Office.Interop.Word.TableOfFigures

See Also

Reference

TablesOfFigures Interface

TablesOfFigures Members

Microsoft.Office.Interop.Word Namespace