Word.Interfaces.TableOfAuthoritiesUpdateData interface
An interface for updating data on the TableOfAuthorities object, for use in tableOfAuthorities.set({ ... }).
Properties
| 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. |
| entry |
Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. |
| is |
Specifies whether the category name for a group of entries appears in the table of authorities. |
| is |
Specifies whether the entries in the table of authorities are displayed with their formatting in the table. |
| is |
Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". |
| page |
Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. |
| page |
Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. |
| sequence |
Specifies the Sequence (SEQ) field identifier for the table of authorities. |
| sequence |
Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. |
| tab |
Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. |
Property Details
bookmark
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the name of the bookmark from which to collect table of authorities entries.
bookmark?: string;Property Value
string
Remarks
category
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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?: number;Property Value
number
Remarks
entrySeparator
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number.
entrySeparator?: string;Property Value
string
Remarks
isCategoryHeaderIncluded
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies whether the category name for a group of entries appears in the table of authorities.
isCategoryHeaderIncluded?: boolean;Property Value
boolean
Remarks
isEntryFormattingKept
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies whether the entries in the table of authorities are displayed with their formatting in the table.
isEntryFormattingKept?: boolean;Property Value
boolean
Remarks
isPassimUsed
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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
pageNumberSeparator
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies a separator of up to five characters. This appears between individual page references in the table of authorities.
pageNumberSeparator?: string;Property Value
string
Remarks
pageRangeSeparator
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities.
pageRangeSeparator?: string;Property Value
string
Remarks
sequenceName
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the Sequence (SEQ) field identifier for the table of authorities.
sequenceName?: string;Property Value
string
Remarks
sequenceSeparator
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities.
sequenceSeparator?: string;Property Value
string
Remarks
tabLeader
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the leader character that appears between entries and their associated page numbers in the table of authorities.
tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";Property Value
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"