TablesOfAuthorities.Add Method
Returns a TableOfAuthorities object that represents a table of authorities 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 Category As Object, _
ByRef Bookmark As Object, _
ByRef Passim As Object, _
ByRef KeepEntryFormatting As Object, _
ByRef Separator As Object, _
ByRef IncludeSequenceName As Object, _
ByRef EntrySeparator As Object, _
ByRef PageRangeSeparator As Object, _
ByRef IncludeCategoryHeader As Object, _
ByRef PageNumberSeparator As Object _
) As TableOfAuthorities
'Usage
Dim instance As TablesOfAuthorities
Dim Range As Range
Dim Category As Object
Dim Bookmark As Object
Dim Passim As Object
Dim KeepEntryFormatting As Object
Dim Separator As Object
Dim IncludeSequenceName As Object
Dim EntrySeparator As Object
Dim PageRangeSeparator As Object
Dim IncludeCategoryHeader As Object
Dim PageNumberSeparator As Object
Dim returnValue As TableOfAuthorities
returnValue = instance.Add(Range, Category, _
Bookmark, Passim, KeepEntryFormatting, _
Separator, IncludeSequenceName, _
EntrySeparator, PageRangeSeparator, _
IncludeCategoryHeader, PageNumberSeparator)
TableOfAuthorities Add(
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
)
Parameters
- Range
Type: Microsoft.Office.Interop.Word.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
Type: System.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
Type: System.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
Type: System.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
Type: System.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
Type: System.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
Type: System.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
Type: System.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
Type: System.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
Type: System.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
Type: System.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.
Return Value
Type: Microsoft.Office.Interop.Word.TableOfAuthorities
Remarks
A table of authorities is built from Table of Authorities Entry (TA) fields in a document. Use the MarkCitation method to mark citations to be included in the table of authorities.