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)

Usage

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
Dim tablesOfFigures1 As TablesOfFigures
returnValue = tablesOfFigures1.Add(Range, Caption, IncludeLabel, UseHeadingStyles, UpperHeadingLevel, LowerHeadingLevel, UseFields, TableID, RightAlignPageNumbers, IncludePageNumbers, AddedStyles, UseHyperlinks, HidePageNumbersInWeb)

Syntax

Function Add( _
    <InAttribute()> ByVal Range As Range, _
    <InAttribute()> Optional ByRef Caption As Object, _
    <InAttribute()> Optional ByRef IncludeLabel As Object, _
    <InAttribute()> Optional ByRef UseHeadingStyles As Object, _
    <InAttribute()> Optional ByRef UpperHeadingLevel As Object, _
    <InAttribute()> Optional ByRef LowerHeadingLevel As Object, _
    <InAttribute()> Optional ByRef UseFields As Object, _
    <InAttribute()> Optional ByRef TableID As Object, _
    <InAttribute()> Optional ByRef RightAlignPageNumbers As Object, _
    <InAttribute()> Optional ByRef IncludePageNumbers As Object, _
    <InAttribute()> Optional ByRef AddedStyles As Object, _
    <InAttribute()> Optional ByRef UseHyperlinks As Object, _
    <InAttribute()> Optional ByRef HidePageNumbersInWeb As Object _
) As TableOfFigures

TableOfFigures Add(
    [In] Range Range, 
    [In, Optional] ref object Caption, 
    [In, Optional] ref object IncludeLabel, 
    [In, Optional] ref object UseHeadingStyles, 
    [In, Optional] ref object UpperHeadingLevel, 
    [In, Optional] ref object LowerHeadingLevel, 
    [In, Optional] ref object UseFields, 
    [In, Optional] ref object TableID, 
    [In, Optional] ref object RightAlignPageNumbers, 
    [In, Optional] ref object IncludePageNumbers, 
    [In, Optional] ref object AddedStyles, 
    [In, Optional] ref object UseHyperlinks, 
    [In, Optional] ref object HidePageNumbersInWeb
);

public: TableOfFigures^ Add(
    Range^ Range, 
    &Object^ Caption, 
    &Object^ IncludeLabel, 
    &Object^ UseHeadingStyles, 
    &Object^ UpperHeadingLevel, 
    &Object^ LowerHeadingLevel, 
    &Object^ UseFields, 
    &Object^ TableID, 
    &Object^ RightAlignPageNumbers, 
    &Object^ IncludePageNumbers, 
    &Object^ AddedStyles, 
    &Object^ UseHyperlinks, 
    &Object^ HidePageNumbersInWeb
);

public TableOfFigures Add(
    /*in*/Range Range, 
    /*in*/System.Object Caption, 
    /*in*/System.Object IncludeLabel, 
    /*in*/System.Object UseHeadingStyles, 
    /*in*/System.Object UpperHeadingLevel, 
    /*in*/System.Object LowerHeadingLevel, 
    /*in*/System.Object UseFields, 
    /*in*/System.Object TableID, 
    /*in*/System.Object RightAlignPageNumbers, 
    /*in*/System.Object IncludePageNumbers, 
    /*in*/System.Object AddedStyles, 
    /*in*/System.Object UseHyperlinks, 
    /*in*/System.Object HidePageNumbersInWeb
);

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

Parameters

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

• Caption
  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
  Optional Object. True to include the caption label and caption number in the table of figures. The default value is True.

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

• UpperHeadingLevel
  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
  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
  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
  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
  Optional Object. True align page numbers with the right margin in the table of figures. The default value is True.

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

• AddedStyles
  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
  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
  Optional Object. True if page numbers in a table of figures should be hidden when publishing to the Web. The default value is True.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, and Windows 2000

Target Platforms

See Also

Reference

TablesOfFigures Interface
Microsoft.Office.Interop.Word Namespace

Other Resources

TablesOfFigures Members