Edit

Share via

Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions interface

Package:
word

Represents a collection of Word.TableOfAuthorities objects in a Word document.

Remarks

[ API set: WordApiDesktop 1.4 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
bookmark

For EACH ITEM in the collection: Specifies the name of the bookmark from which to collect table of authorities entries.
category

For EACH ITEM in the collection: Specifies the category of entries to be included in the table of authorities. 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.
entrySeparator

For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number.
isCategoryHeaderIncluded

For EACH ITEM in the collection: Specifies whether the category name for a group of entries appears in the table of authorities.
isEntryFormattingKept

For EACH ITEM in the collection: Specifies whether the entries in the table of authorities are displayed with their formatting in the table.
isPassimUsed

For EACH ITEM in the collection: Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim".
pageNumberSeparator

For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between individual page references in the table of authorities.
pageRangeSeparator

For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities.
range

For EACH ITEM in the collection: Gets the portion of a document that is this table of authorities.
sequenceName

For EACH ITEM in the collection: Specifies the Sequence (SEQ) field identifier for the table of authorities.
sequenceSeparator

For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities.
tabLeader

For EACH ITEM in the collection: Specifies the leader character that appears between entries and their associated page numbers in the table of authorities.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

bookmark

For EACH ITEM in the collection: Specifies the name of the bookmark from which to collect table of authorities entries.

bookmark?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

category

For EACH ITEM in the collection: Specifies the category of entries to be included in the table of authorities. 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.

category?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

entrySeparator

For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number.

entrySeparator?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isCategoryHeaderIncluded

For EACH ITEM in the collection: Specifies whether the category name for a group of entries appears in the table of authorities.

isCategoryHeaderIncluded?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isEntryFormattingKept

For EACH ITEM in the collection: Specifies whether the entries in the table of authorities are displayed with their formatting in the table.

isEntryFormattingKept?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isPassimUsed

For EACH ITEM in the collection: Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim".

isPassimUsed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

pageNumberSeparator

For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between individual page references in the table of authorities.

pageNumberSeparator?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

pageRangeSeparator

For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities.

pageRangeSeparator?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

range

For EACH ITEM in the collection: Gets the portion of a document that is this table of authorities.

range?: Word.Interfaces.RangeLoadOptions;

Property Value

Word.Interfaces.RangeLoadOptions

Remarks

[ API set: WordApiDesktop 1.4 ]

sequenceName

For EACH ITEM in the collection: Specifies the Sequence (SEQ) field identifier for the table of authorities.

sequenceName?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

sequenceSeparator

For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities.

sequenceSeparator?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

tabLeader

For EACH ITEM in the collection: Specifies the leader character that appears between entries and their associated page numbers in the table of authorities.

tabLeader?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]