Word.TableOfAuthorities class

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

bookmark: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

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

entrySeparator: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

isCategoryHeaderIncluded: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

isEntryFormattingKept: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

isPassimUsed: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

pageNumberSeparator: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

pageRangeSeparator: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

readonly range: Word.Range;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

sequenceName: string;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Deletes this table of authorities.

delete(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.TableOfAuthorities;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableOfAuthorities;

Parameters

Returns

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.TableOfAuthorities): void;

Parameters

Returns

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.TableOfAuthorities object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.TableOfAuthoritiesData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.TableOfAuthoritiesData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.TableOfAuthorities;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.TableOfAuthorities;

Returns