TablesOfFigures.Add Method

Reference

Definition

Namespace:: Microsoft.Office.Interop.Word

Assembly:: Microsoft.Office.Interop.Word.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public Microsoft.Office.Interop.Word.TableOfFigures Add (Microsoft.Office.Interop.Word.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);

abstract member Add : Microsoft.Office.Interop.Word.Range * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj * obj -> Microsoft.Office.Interop.Word.TableOfFigures

Public Function Add (Range As Range, Optional ByRef Caption As Object, Optional ByRef IncludeLabel As Object, Optional ByRef UseHeadingStyles As Object, Optional ByRef UpperHeadingLevel As Object, Optional ByRef LowerHeadingLevel As Object, Optional ByRef UseFields As Object, Optional ByRef TableID As Object, Optional ByRef RightAlignPageNumbers As Object, Optional ByRef IncludePageNumbers As Object, Optional ByRef AddedStyles As Object, Optional ByRef UseHyperlinks As Object, Optional ByRef HidePageNumbersInWeb As Object) As TableOfFigures

Parameters

Range: Range

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

Caption: 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: Object

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

UseHeadingStyles: Object

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

UpperHeadingLevel: 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: 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: Object

Optional Object. True to use Table of Contents Entry (TC) fields to create the table of figures. Use the MarkEntry(Range, Object, Object, Object, Object) method to mark entries you want to include in the table of figures. The default value is False.

TableID: 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: Object

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

IncludePageNumbers: Object

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

AddedStyles: 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: 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: 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.

Returns

TableOfFigures

Applies to