Edit

Share via


Word.Interfaces.TableOfAuthoritiesLoadOptions interface

Represents a table of authorities 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

Specifies the name of the bookmark from which to collect table of authorities entries.

category

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

Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number.

isCategoryHeaderIncluded

Specifies whether the category name for a group of entries appears in the table of authorities.

isEntryFormattingKept

Specifies whether the entries in the table of authorities are displayed with their formatting in the table.

isPassimUsed

Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim".

pageNumberSeparator

Specifies a separator of up to five characters. This appears between individual page references in the table of authorities.

pageRangeSeparator

Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities.

range

Gets the portion of a document that is this table of authorities.

sequenceName

Specifies the Sequence (SEQ) field identifier for the table of authorities.

sequenceSeparator

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

tabLeader

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

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

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

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

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

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

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

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

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

Gets the portion of a document that is this table of authorities.

range?: Word.Interfaces.RangeLoadOptions;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

sequenceName

Specifies the Sequence (SEQ) field identifier for the table of authorities.

sequenceName?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

sequenceSeparator

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

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 ]