Edit

Share via


Word.TableOfAuthoritiesAddOptions interface

Specifies the options for adding to a Word.TableOfAuthoritiesCollection object.

Remarks

[ API set: WordApiDesktop 1.4 ]

Properties

bookmark

If provided, specifies the string name of the bookmark from which to collect entries for a table of authorities. When 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.

category

If provided, specifies the category of entries to include in a 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 of the Table of Authorities dialog. To learn how to access this through the Word UI, see Create a table of authorities. The default value is 1.

entrySeparator

If provided, specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. Corresponds to the \e switch for a Table of Authorities (TOA) field. If omitted, no separator is used.

includeCategoryHeader

If provided, specifies whether the category name for each group of entries appears in a table of authorities (e.g., "Cases"). Corresponds to the \h switch for a Table of Authorities (TOA) field. The default value is true.

keepEntryFormatting

If provided, specifies whether the entries in a table of authorities are displayed with their formatting in the table. Corresponds to the \f switch for a Table of Authorities (TOA) field. The default value is true.

pageNumberSeparator

If provided, specifies a separator of up to five characters. This appears between individual page references in a table of authorities. Corresponds to the \l switch for a Table of Authorities (TOA) field. If omitted, a comma and a space (", ") are used.

pageRangeSeparator

If provided, specifies a separator of up to five characters. This appears between ranges of pages in a table of authorities. Corresponds to the \g switch for a Table of Authorities (TOA) field. If omitted, an en dash ("–") is used.

sequenceName

If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities. Corresponds to the \s switch for a Table of Authorities (TOA) field.

sequenceSeparator

If provided, specifies a separator of up to five characters. This appears between the sequence number and the page number in a table of authorities. Corresponds to the \d switch for a Table of Authorities (TOA) field. If omitted, a hyphen ("-") is used.

usePassim

If provided, specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". Corresponds to the \p switch for a Table of Authorities (TOA) field. The default value is false.

Property Details

bookmark

If provided, specifies the string name of the bookmark from which to collect entries for a table of authorities. When 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.

bookmark?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

category

If provided, specifies the category of entries to include in a 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 of the Table of Authorities dialog. To learn how to access this through the Word UI, see Create a table of authorities. The default value is 1.

category?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.4 ]

entrySeparator

If provided, specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. Corresponds to the \e switch for a Table of Authorities (TOA) field. If omitted, no separator is used.

entrySeparator?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

includeCategoryHeader

If provided, specifies whether the category name for each group of entries appears in a table of authorities (e.g., "Cases"). Corresponds to the \h switch for a Table of Authorities (TOA) field. The default value is true.

includeCategoryHeader?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

keepEntryFormatting

If provided, specifies whether the entries in a table of authorities are displayed with their formatting in the table. Corresponds to the \f switch for a Table of Authorities (TOA) field. The default value is true.

keepEntryFormatting?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

pageNumberSeparator

If provided, specifies a separator of up to five characters. This appears between individual page references in a table of authorities. Corresponds to the \l switch for a Table of Authorities (TOA) field. If omitted, a comma and a space (", ") are used.

pageNumberSeparator?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

pageRangeSeparator

If provided, specifies a separator of up to five characters. This appears between ranges of pages in a table of authorities. Corresponds to the \g switch for a Table of Authorities (TOA) field. If omitted, an en dash ("–") is used.

pageRangeSeparator?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

sequenceName

If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities. Corresponds to the \s switch for a Table of Authorities (TOA) field.

sequenceName?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

sequenceSeparator

If provided, specifies a separator of up to five characters. This appears between the sequence number and the page number in a table of authorities. Corresponds to the \d switch for a Table of Authorities (TOA) field. If omitted, a hyphen ("-") is used.

sequenceSeparator?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.4 ]

usePassim

If provided, specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". Corresponds to the \p switch for a Table of Authorities (TOA) field. The default value is false.

usePassim?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]