TablesOfAuthorities.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 TableOfAuthorities object that represents a table of authorities added to a document.

public Microsoft.Office.Interop.Word.TableOfAuthorities Add (Microsoft.Office.Interop.Word.Range Range, ref object Category, ref object Bookmark, ref object Passim, ref object KeepEntryFormatting, ref object Separator, ref object IncludeSequenceName, ref object EntrySeparator, ref object PageRangeSeparator, ref object IncludeCategoryHeader, ref object PageNumberSeparator);

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

Public Function Add (Range As Range, Optional ByRef Category As Object, Optional ByRef Bookmark As Object, Optional ByRef Passim As Object, Optional ByRef KeepEntryFormatting As Object, Optional ByRef Separator As Object, Optional ByRef IncludeSequenceName As Object, Optional ByRef EntrySeparator As Object, Optional ByRef PageRangeSeparator As Object, Optional ByRef IncludeCategoryHeader As Object, Optional ByRef PageNumberSeparator As Object) As TableOfAuthorities

Parameters

Range: Range

Required Range object. The range where you want the table of authorities to appear. The table of authorities replaces the range if the range isn't collapsed.

Category: Object

Optional Object. The category of entries you want to include in the table of authorities. Corresponds to the \c switch for a Table of Authorities (TOA) field. Values 0 through 16 correspond to the items listed in the Category box on the Table of Authorities tab in the Index and Tables dialog box (Reference command, Insert menu). The default value is 1.

Bookmark: Object

Optional Object. The string name of the bookmark from which you want to collect entries for the table of authorities. If Bookmark is specified, the entries are collected only from the portion of the document marked by the bookmark. Corresponds to the \b switch for a Table of Authorities (TOA) field.

Passim: Object

Optional Object. True to replace five or more page references to the same authority with Passim in the table of authorities. Corresponds to the \p switch for a Table of Authorities (TOA) field. If this argument is omitted, Passim is assumed to be False.

KeepEntryFormatting: Object

Optional Object. True to apply formatting from table of authorities entries to the entries in the table of authorities. Corresponds to the \f switch for a Table of Authorities (TOA) field. If this argument is omitted, KeepEntryFormatting is assumed to be True.

Separator: Object

Optional Object. The characters (up to five) between each sequence number and its page number in the table of authorities. Corresponds to the \d switch for a Table of Authorities (TOA) field. If argument is omitted, a hyphen (-) is used.

IncludeSequenceName: Object

Optional Object. A string that specifies the Sequence (SEQ) field identifier for the table of authorities. Corresponds to the \s switch for a Table of Authorities (TOA) field.

EntrySeparator: Object

Optional Object. The characters (up to five) that separate each entry and its page number in the table of authorities. Corresponds to the \e switch for a Table of Authorities (TOA) field. If this argument is omitted, no separator is used.

PageRangeSeparator: Object

Optional Object. The characters (up to five) that separate the beginning and ending page numbers in each page range the table of authorities. Corresponds to the \g switch for a Table of Authorities (TOA) field. If this argument is omitted, an en dash is used.

IncludeCategoryHeader: Object

Optional Object. True to have the category name for each group of entries appear in the table of authorities (for example, Cases). Corresponds to the \h switch for a Table of Authorities (TOA) field. If this argument is omitted, IncludeCategoryHeader is assumed to be True.

PageNumberSeparator: Object

Optional Object. The characters (up to five) that separate individual page numbers within page references in the table of authorities. Corresponds to the \l switch for a Table of Authorities (TOA) field. If this argument is omitted, a comma and a space are used.

Returns

TableOfAuthorities

Remarks

A table of authorities is built from Table of Authorities Entry (TA) fields in a document. Use the MarkCitation(Range, String, Object, Object, Object) method to mark citations to be included in the table of authorities.

Applies to