diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 58f64c941d4920..79cb7ea7023706 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -100321,8 +100321,7 @@ declare namespace Word { * Represents the {@link Word.Editor | editors} in a protected (read-only) Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class EditorCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -100331,8 +100330,7 @@ declare namespace Word { * Returns an `Editor` object that represents a new permission for the specified user to modify a range within the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param editorId The user's email alias (if in the same domain) or an email address. */ @@ -100341,8 +100339,7 @@ declare namespace Word { * Returns an `Editor` object that represents a new permission for the specified group of users to modify a range within the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param editorType An `EditorType` that represents a group of users. */ @@ -100351,8 +100348,7 @@ declare namespace Word { * Returns an `Editor` object that represents a new permission for the specified group of users to modify a range within the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param editorType An `EditorType` that represents a group of users. */ @@ -100361,16 +100357,14 @@ declare namespace Word { * Returns the number of items in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ getCount(): OfficeExtension.ClientResult; /** * Gets an `Editor` object by its index in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param index The index of the item to retrieve. */ @@ -100410,8 +100404,7 @@ declare namespace Word { * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class Editor extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -100420,32 +100413,28 @@ declare namespace Word { * Gets a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly nextRange: Word.Range; /** * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly id: string; /** * Gets the name of the editor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly name: string; /** @@ -100460,24 +100449,21 @@ declare namespace Word { * Deletes the `Editor` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete(): void; /** * Removes all editing permissions in the document for the editor. The editor will be deleted next time the document opens. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ removeAllPermissions(): void; /** * Selects all the shapes in the document that were inserted or edited by the editor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectAllShapes(): void; /** @@ -100519,8 +100505,7 @@ declare namespace Word { * Represents the coauthoring conflicts in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class ConflictCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -100531,8 +100516,7 @@ declare namespace Word { * Accepts all of the user's changes, removes the conflicts, and merges the changes into the server copy of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ acceptAll(): void; /** @@ -100549,8 +100533,7 @@ declare namespace Word { * Rejects all of the user's changes and retains the server copy of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rejectAll(): void; /** @@ -100589,8 +100572,7 @@ declare namespace Word { * Represents a coauthoring conflict in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class Conflict extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -100599,16 +100581,14 @@ declare namespace Word { * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Gets the `RevisionType` for the `Conflict` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; /** @@ -100623,16 +100603,14 @@ declare namespace Word { * Accepts the user's change and removes the conflict. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ accept(): void; /** * Rejects the user's change, removes the conflict, and accepts the server copy of the change for the conflict. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ reject(): void; /** @@ -101133,16 +101111,14 @@ declare namespace Word { * Returns a `FontNameCollection` object that represents all the available font names in Microsoft Word. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly fontNames: Word.FontNameCollection; /** * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly listTemplateGalleries: Word.ListTemplateGalleryCollection; /** @@ -102781,8 +102757,7 @@ declare namespace Word { * Represents a coauthoring lock in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class CoauthoringLock extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -102791,24 +102766,21 @@ declare namespace Word { * Gets the owner of the lock. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly owner: Word.Coauthor; /** * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly type: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; /** @@ -102823,8 +102795,7 @@ declare namespace Word { * Removes this lock, even if it belongs to a different user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unlock(): void; /** @@ -102866,8 +102837,7 @@ declare namespace Word { * Represents a collection of coauthoring locks in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class CoauthoringLockCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -102878,8 +102848,7 @@ declare namespace Word { * Returns a `CoauthoringLock` object that represents a lock added to a specified range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. The options to further configure the coauthoring lock. */ @@ -102888,8 +102857,7 @@ declare namespace Word { * Removes all ephemeral locks from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unlockEphemeralLocks(): void; /** @@ -102928,24 +102896,21 @@ declare namespace Word { * Specifies the options for adding to a {@link Word.CoauthoringLockCollection} object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface CoauthoringLockAddOptions { /** * If provided, specifies the range to which the lock is added. If not provided, the new lock is placed on the paragraph that contains the insertion point. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Range; /** * If provided, specifies the type of lock. If not provided, the lock type is set to `reservation`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; } @@ -102953,8 +102918,7 @@ declare namespace Word { * Represents a coauthor in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class Coauthor extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -102963,40 +102927,35 @@ declare namespace Word { * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly locks: Word.CoauthoringLockCollection; /** * Gets the email address of the coauthor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly emailAddress: string; /** * Gets the unique identifier for the `Coauthor` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly id: string; /** * Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isMe: boolean; /** * Gets the display name of the coauthor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly name: string; /** @@ -103038,8 +102997,7 @@ declare namespace Word { * Contains a collection of {@link Word.Coauthor} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class CoauthorCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -103082,8 +103040,7 @@ declare namespace Word { * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class Coauthoring extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -103092,64 +103049,56 @@ declare namespace Word { * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly authors: Word.CoauthorCollection; /** * Gets a `ConflictCollection` object that represents all the conflicts in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly conflicts: Word.ConflictCollection; /** * Gets a `CoauthoringLockCollection` object that represents the locks in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly locks: Word.CoauthoringLockCollection; /** * Gets a `Coauthor` object that represents the current user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly me: Word.Coauthor; /** * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly updates: Word.CoauthoringUpdateCollection; /** * Gets whether this document can be coauthored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly canCoauthor: boolean; /** * Gets whether the document can be automatically merged. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly canMerge: boolean; /** * Gets whether the document has pending updates that have not been accepted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly pendingUpdates: boolean; /** @@ -103191,8 +103140,7 @@ declare namespace Word { * Represents a coauthoring update in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class CoauthoringUpdate extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -103201,8 +103149,7 @@ declare namespace Word { * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** @@ -103252,8 +103199,7 @@ declare namespace Word { * Contains a collection of {@link Word.CoauthoringUpdate} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class CoauthoringUpdateCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -103760,8 +103706,7 @@ declare namespace Word { * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class ConditionalStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -103770,64 +103715,56 @@ declare namespace Word { * Returns a `BorderUniversalCollection` object that represents all the borders for the conditional style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly borders: Word.BorderUniversalCollection; /** * Returns a `Font` object that represents the font formatting for the conditional style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly font: Word.Font; /** * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly paragraphFormat: Word.ParagraphFormat; /** * Returns a `ShadingUniversal` object that represents the shading of the conditional style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly shading: Word.ShadingUniversal; /** * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bottomPadding: number; /** * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftPadding: number; /** * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightPadding: number; /** * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ topPadding: number; /** @@ -106710,8 +106647,7 @@ declare namespace Word { * Gets a `Shape` object that represents the background image for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly background: Word.Shape; /** @@ -106732,48 +106668,42 @@ declare namespace Word { * Returns a `BookmarkCollection` object that represents all the bookmarks in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly bookmarks: Word.BookmarkCollection; /** * Gets a `DocumentProperties` object that represents all the built-in document properties for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly builtInDocumentProperties: Word.DocumentProperties; /** * Gets the `RangeScopedCollection` object that represents all the characters in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly characters: Word.RangeScopedCollection; /** * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly coauthoring: Word.Coauthoring; /** * Gets a `CommentCollection` object that represents all the comments in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly comments: Word.CommentCollection; /** * Gets a `Range` object that represents the main document story. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly content: Word.Range; /** @@ -106787,8 +106717,7 @@ declare namespace Word { * Gets a `DocumentProperties` collection that represents all the custom document properties for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly customDocumentProperties: Word.DocumentProperties; /** @@ -106809,8 +106738,7 @@ declare namespace Word { * Gets a `FieldCollection` object that represents all the fields in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly fields: Word.FieldCollection; /** @@ -106824,8 +106752,7 @@ declare namespace Word { * Gets a `RangeCollection` object that represents the sentences that failed the grammar check in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly grammaticalErrors: Word.RangeCollection; /** @@ -106839,32 +106766,28 @@ declare namespace Word { * Returns an `IndexCollection` object that represents all the indexes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly indexes: Word.IndexCollection; /** * Gets a `ParagraphCollection` object that represents all the numbered paragraphs in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly listParagraphs: Word.ParagraphCollection; /** * Returns a `ListTemplateCollection` object that represents all the list templates in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly listTemplates: Word.ListTemplateCollection; /** * Gets a `ListCollection` object that contains all the formatted lists in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly lists: Word.ListCollection; /** @@ -106878,8 +106801,7 @@ declare namespace Word { * Gets a `ParagraphCollection` object that represents all the paragraphs in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly paragraphs: Word.ParagraphCollection; /** @@ -106893,16 +106815,14 @@ declare namespace Word { * Gets a `ReadabilityStatisticCollection` object that represents the readability statistics for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly readabilityStatistics: Word.ReadabilityStatisticCollection; /** * Gets the collection of revisions that represents the tracked changes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly revisions: Word.RevisionCollection; /** @@ -106916,16 +106836,14 @@ declare namespace Word { * Returns a `Selection` object that represents the current selection in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly selection: Word.Selection; /** * Gets the `RangeScopedCollection` object that represents all the sentences in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly sentences: Word.RangeScopedCollection; /** @@ -106939,72 +106857,63 @@ declare namespace Word { * Gets a `RangeCollection` object that represents the words identified as spelling errors in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly spellingErrors: Word.RangeCollection; /** * Gets a `RangeCollection` object that represents all the stories in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly storyRanges: Word.RangeCollection; /** * Gets a `StyleCollection` for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly styles: Word.StyleCollection; /** * Returns a `TableOfAuthoritiesCategoryCollection` object that represents the available table of authorities categories in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection; /** * Gets a `TableCollection` object that represents all the tables in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly tables: Word.TableCollection; /** * Returns a `TableOfAuthoritiesCollection` object that represents all the tables of authorities in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection; /** * Returns a `TableOfContentsCollection` object that represents all the tables of contents in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly tablesOfContents: Word.TableOfContentsCollection; /** * Returns a `TableOfFiguresCollection` object that represents all the tables of figures in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly tablesOfFigures: Word.TableOfFiguresCollection; /** * Gets the `WebSettings` object for webpage-related attributes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly webSettings: Word.WebSettings; /** @@ -107018,80 +106927,70 @@ declare namespace Word { * Gets the `RangeScopedCollection` object that represents each word in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly words: Word.RangeScopedCollection; /** * Gets the name of the active theme and formatting options. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly activeTheme: string; /** * Gets the display name of the active theme. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly activeThemeDisplayName: string; /** * Gets whether Word encrypts file properties for password-protected documents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areFilePropertiesPasswordEncrypted: boolean; /** * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areGrammaticalErrorsShown: boolean; /** * Specifies whether to use the default math settings when creating new equations. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areMathDefaultsUsed: boolean; /** * Specifies whether to disable features introduced after a specified version. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areNewerFeaturesDisabled: boolean; /** * Specifies whether Microsoft Word underlines spelling errors in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areSpellingErrorsShown: boolean; /** * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areStylesUpdatedOnOpen: boolean; /** * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTrueTypeFontsEmbedded: boolean; /** @@ -107119,16 +107018,14 @@ declare namespace Word { * Gets the code name for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly codeName: string; /** * Gets the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current"; /** @@ -107142,152 +107039,133 @@ declare namespace Word { * Gets a random number that Word assigns to changes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly currentRsid: number; /** * Specifies the interval (in points) between the default tab stops in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ defaultTabStop: number; /** * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ defaultTargetFrame: string; /** * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ doNotEmbedSystemFonts: boolean; /** * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ encryptionProvider: string; /** * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** * Specifies the line break control level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formattingIsNextLevelShown: boolean; /** * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formattingIsUserStyleNameShown: boolean; /** * Gets the name of a document, including the path. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly fullName: string; /** * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridDistanceHorizontal: number; /** * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridDistanceVertical: number; /** * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridIsOriginFromMargin: boolean; /** * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridOriginHorizontal: number; /** * Specifies the vertical origin point for the invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridOriginVertical: number; /** * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridSpaceBetweenHorizontalLines: number; /** * Specifies the interval for vertical character gridlines in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridSpaceBetweenVerticalLines: number; /** * Gets whether a password is required to open the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly hasPassword: boolean; /** * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly hasVbProject: boolean; /** @@ -107301,240 +107179,210 @@ declare namespace Word { * Specifies the width of the hyphenation zone, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hyphenationZone: number; /** * Specifies whether automatic formatting options override formatting restrictions. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isAutoFormatOverrideOn: boolean; /** * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isChartDataPointTracked: boolean; /** * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isCompatible: boolean; /** * Specifies whether the document is final. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFinal: boolean; /** * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFontsSubsetSaved: boolean; /** * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormsDataPrinted: boolean; /** * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormsDataSaved: boolean; /** * Specifies whether a grammar check has been run on the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isGrammarChecked: boolean; /** * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isInAutoSave: boolean; /** * Gets whether the document is in form design mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isInFormsDesign: boolean; /** * Specifies whether Word kerns half-width Latin characters and punctuation marks. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isKerningByAlgorithm: boolean; /** * Specifies whether to embed speech and handwriting data. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLinguisticDataEmbedded: boolean; /** * Gets whether this document is a master document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isMasterDocument: boolean; /** * Specifies whether Word optimizes the document for Word 97. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isOptimizedForWord97: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPostScriptPrintedOverText: boolean; /** * Specifies whether users can change the Quick Style set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isQuickStyleSetLocked: boolean; /** * Gets whether changes to the document cannot be saved to the original document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isReadOnly: boolean; /** * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isReadOnlyRecommended: boolean; /** * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSnappedToGrid: boolean; /** * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSnappedToShapes: boolean; /** * Specifies whether spelling has been checked throughout the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSpellingChecked: boolean; /** * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isStyleEnforced: boolean; /** * Gets whether this document is a subdocument of a master document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isSubdocument: boolean; /** * Specifies whether users can change the document theme. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isThemeLocked: boolean; /** * Specifies whether the document was created or opened by the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isUserControl: boolean; /** * Gets whether the VBA project is digitally signed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isVbaSigned: boolean; /** * Gets whether the document is protected with a write password. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isWriteReserved: boolean; /** * Specifies the character spacing adjustment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; /** @@ -107548,144 +107396,126 @@ declare namespace Word { * Specifies the kinsoku characters after which Word will not break a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noLineBreakAfter: string; /** * Specifies the kinsoku characters before which Word will not break a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noLineBreakBefore: string; /** * Gets the encoding used to open the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly openEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Gets the title of the original document after legal-blackline comparison. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly originalDocumentTitle: string; /** * Sets a password that must be supplied to open the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ password: string; /** * Gets the algorithm used for password encryption. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly passwordEncryptionAlgorithm: string; /** * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly passwordEncryptionKeyLength: number; /** * Gets the name of the password encryption provider. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly passwordEncryptionProvider: string; /** * Gets the disk or the web path to the document (excludes the document name). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly path: string; /** * Specifies whether revision marks are printed with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ printRevisions: boolean; /** * Gets the protection type for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly protectionType: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"; /** * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutSizeX: number; /** * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutSizeY: number; /** * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingModeIsLayoutFrozen: boolean; /** * Specifies whether Word removes user information upon saving. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ removePersonalInformationOnSave: boolean; /** * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly revisedDocumentTitle: string; /** * Specifies the encoding used when saving the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Gets the file format of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"; /** @@ -107699,88 +107529,77 @@ declare namespace Word { * Specifies the encoding for saving as encoded text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Specifies how Word marks line and paragraph breaks in text files. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; /** * Specifies whether to track formatting changes when change tracking is on. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackFormatting: boolean; /** * Specifies whether to mark moved text when Track Changes is on. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackMoves: boolean; /** * Specifies whether changes are tracked in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackRevisions: boolean; /** * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackedChangesAreDateAndTimeRemoved: boolean; /** * Gets the document type (template or document). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly type: Word.DocumentType | "Document" | "Template" | "Frameset"; /** * Sets a password for saving changes to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ writePassword: string; /** * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlAreAdvancedErrorsShown: boolean; /** * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlIsXsltUsedWhenSaving: boolean; /** * Specifies the path and file name for the XSLT to apply when saving a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlSaveThroughXslt: string; /** @@ -107795,24 +107614,21 @@ declare namespace Word { * Accepts all tracked changes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ acceptAllRevisions(): void; /** * Accepts all revisions in the document that are displayed on the screen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ acceptAllRevisionsShown(): void; /** * Activates the document so that it becomes the active document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ activate(): void; /** @@ -107839,16 +107655,14 @@ declare namespace Word { * Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ addToFavorites(): void; /** * Applies the specified Quick Style set to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param style The style set to apply. */ @@ -107857,8 +107671,7 @@ declare namespace Word { * Applies the specified Quick Style set to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param style The style set to apply. */ @@ -107867,8 +107680,7 @@ declare namespace Word { * Applies the specified theme to this document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param name The name of the theme. */ @@ -107877,16 +107689,14 @@ declare namespace Word { * Automatically formats the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ autoFormat(): void; /** * Returns `true` if Microsoft Word can check in the document to a server. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * @returns `true` if the document can be checked in; otherwise, `false`. */ canCheckin(): OfficeExtension.ClientResult; @@ -107894,16 +107704,14 @@ declare namespace Word { * Searches all text in a Japanese language document and displays instances where character usage is inconsistent for the same words. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ checkConsistencyJapanese(): void; /** * Begins a spelling and grammar check for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ checkGrammar(): void; /** @@ -107962,8 +107770,7 @@ declare namespace Word { * Switches the document from print preview to the previous view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ closePrintPreview(): void; /** @@ -107996,7 +107803,7 @@ declare namespace Word { * @param statistic The type of statistic to return. * @param includeFootnotesAndEndnotes Optional. Whether to include footnotes and endnotes. The default value is `false`. */ - computeStatistics(statistic: Word.Statistic, includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult; + computeStatistics(statistic: Word.StatisticType, includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult; /** * Returns a statistic based on the contents of the document. * @@ -108012,24 +107819,21 @@ declare namespace Word { * Converts the file to the newest format and enables all features. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ convert(): void; /** * Converts automatic hyphens to manual hyphens. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ convertAutoHyphens(): void; /** * Changes the list numbers and {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | LISTNUM fields} in the document to text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param numberType Optional. The type of numbering to convert. */ @@ -108038,8 +107842,7 @@ declare namespace Word { * Changes the list numbers and {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | LISTNUM fields} in the document to text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param numberType Optional. The type of numbering to convert. */ @@ -108048,8 +107851,7 @@ declare namespace Word { * Reconverts a Vietnamese document to Unicode using a code page other than the default. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param codePageOrigin The code page to use. */ @@ -108058,8 +107860,7 @@ declare namespace Word { * Copies styles from the specified template to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param StyleTemplate The template to copy styles from. */ @@ -108079,24 +107880,21 @@ declare namespace Word { * Deletes all comments from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ deleteAllComments(): void; /** * Deletes all revisions in the document that are displayed on the screen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ deleteAllCommentsShown(): void; /** * Deletes all handwritten ink annotations in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ deleteAllInkAnnotations(): void; /** @@ -108201,8 +107999,7 @@ declare namespace Word { * Decreases the font size of text just enough so that the document page count drops by one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitToPages(): void; /** @@ -108219,8 +108016,7 @@ declare namespace Word { * Fixes the layout of the document in Web view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ freezeLayout(): void; /** @@ -108267,8 +108063,7 @@ declare namespace Word { * Returns an array of items that can be cross-referenced based on the specified cross-reference type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param referenceType The type of reference. */ @@ -108277,8 +108072,7 @@ declare namespace Word { * Returns an array of items that can be cross-referenced based on the specified cross-reference type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param referenceType The type of reference. */ @@ -108382,16 +108176,14 @@ declare namespace Word { * Locks the file on the server preventing anyone else from editing it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lockServerFile(): void; /** * Sets the compatibility options. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ makeCompatibilityDefault(): void; /** @@ -108416,16 +108208,14 @@ declare namespace Word { * Posts the document to a public folder in Microsoft Exchange. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ post(): void; /** * Opens PowerPoint with the Word document loaded. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ presentIt(): void; /** @@ -108442,8 +108232,7 @@ declare namespace Word { * Switches the view to print preview. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ printPreview(): void; /** @@ -108472,8 +108261,7 @@ declare namespace Word { * Redoes the last action that was undone (reverses the `undo` method). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param times Optional. The number of actions to redo. * @returns `true` if the actions were redone successfully; otherwise, `false`. @@ -108483,32 +108271,28 @@ declare namespace Word { * Rejects all tracked changes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rejectAllRevisions(): void; /** * Rejects all revisions in the document that are displayed on the screen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rejectAllRevisionsShown(): void; /** * Reloads a cached document by resolving the hyperlink to the document and downloading it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ reload(): void; /** * Reloads the document based on an HTML document, using the document encoding. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param encoding The encoding to use. */ @@ -108517,8 +108301,7 @@ declare namespace Word { * Reloads the document based on an HTML document, using the document encoding. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param encoding The encoding to use. */ @@ -108527,8 +108310,7 @@ declare namespace Word { * Removes sensitive information, properties, comments, and other metadata from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param removeDocInfoType The type of document info to remove. */ @@ -108537,8 +108319,7 @@ declare namespace Word { * Removes sensitive information, properties, comments, and other metadata from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param removeDocInfoType The type of document info to remove. */ @@ -108547,16 +108328,14 @@ declare namespace Word { * Purges the document of locked styles when formatting restrictions have been applied in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ removeLockedStyles(): void; /** * Removes numbers or bullets from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param numberType Optional. The type of numbering to remove. */ @@ -108565,8 +108344,7 @@ declare namespace Word { * Removes numbers or bullets from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param numberType Optional. The type of numbering to remove. */ @@ -108575,16 +108353,14 @@ declare namespace Word { * Removes the active theme from the current document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ removeTheme(): void; /** * Repaginates the entire document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ repaginate(): void; /** @@ -108601,24 +108377,21 @@ declare namespace Word { * Clears all form fields in the document, preparing the form to be filled in again. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ resetFormFields(): void; /** * Returns the document to the last saved reading position. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ returnToLastReadPosition(): OfficeExtension.ClientResult; /** * Runs an auto macro that's stored in the document. If the specified auto macro doesn't exist, nothing happens. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param autoMacro The auto macro to run. */ @@ -108627,8 +108400,7 @@ declare namespace Word { * Runs an auto macro that's stored in the document. If the specified auto macro doesn't exist, nothing happens. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param autoMacro The auto macro to run. */ @@ -108661,8 +108433,7 @@ declare namespace Word { * Saves the group of quick styles currently in use. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param fileName The name of the file to save. */ @@ -108689,16 +108460,14 @@ declare namespace Word { * Selects the contents of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ select(): void; /** * Returns all content controls with the specified tag. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param tag The tag value to filter content controls. */ @@ -108707,8 +108476,7 @@ declare namespace Word { * Returns a `ContentControlCollection` object that represents all the content controls in the document with the specified title. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param title The title of the content controls. */ @@ -108717,8 +108485,7 @@ declare namespace Word { * Returns a `ContentControlCollection` object that represents all content controls in the document that are linked to the specific custom XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param node The custom XML node. */ @@ -108727,8 +108494,7 @@ declare namespace Word { * Returns an `XmlNodeCollection` object that represents all the nodes that match the XPath parameter in the order in which they appear in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param xPath The XPath expression. * @param options Optional. Configuration options for the nodes selection. @@ -108738,8 +108504,7 @@ declare namespace Word { * Returns an `XmlNode` object that represents the first node that matches the XPath parameter in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param xPath The XPath expression. * @param options Optional. Configuration options for the node selection. @@ -108749,8 +108514,7 @@ declare namespace Word { * Returns a `ContentControlCollection` object that represents all content controls in the document that are not linked to an XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param stream Optional. The custom XML part. */ @@ -108759,8 +108523,7 @@ declare namespace Word { * Sends the document as a fax, without any user interaction. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param address The fax address. * @param subject Optional. The subject of the fax. @@ -108790,16 +108553,14 @@ declare namespace Word { * Opens a message window for sending the document through Microsoft Exchange. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sendMail(): void; /** * Specifies the table style to use for newly created tables in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param style The style to apply. * @param setInTemplate Whether to set the style in the template. @@ -108809,8 +108570,7 @@ declare namespace Word { * Sets the options Microsoft Word uses for encrypting documents with passwords. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param passwordEncryptionProvider The encryption provider. * @param passwordEncryptionAlgorithm The encryption algorithm. @@ -108822,16 +108582,14 @@ declare namespace Word { * Switches form design mode on or off. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ toggleFormsDesign(): void; /** * Applies the specified Extensible Stylesheet Language Transformation (XSLT) file to this document and replaces the document with the results. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param path The path to the XSLT file. * @param dataOnly Optional. Whether to use data only. @@ -108841,8 +108599,7 @@ declare namespace Word { * Undoes the last action or a sequence of actions, which are displayed in the Undo list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param times Optional. The number of actions to undo. * @returns `true` if the actions were undone successfully; otherwise, `false`. @@ -108852,16 +108609,14 @@ declare namespace Word { * Clears the list of actions that can be undone in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ undoClear(): void; /** * Removes protection from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param password Optional. The password to unprotect the document. */ @@ -108870,32 +108625,28 @@ declare namespace Word { * Copies all styles from the attached template into the document, overwriting any existing styles in the document that have the same name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ updateStyles(): void; /** * Displays the code window for the selected Microsoft ActiveX control in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ viewCode(): void; /** * Displays the property window for the selected Microsoft ActiveX control in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ viewPropertyBrowser(): void; /** * Displays a preview of the current document as it would look if saved as a webpage. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ webPagePreview(): void; /** @@ -109548,16 +109299,14 @@ declare namespace Word { * Gets a `LinkFormat` object that represents the link options of the field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly linkFormat: Word.LinkFormat; /** * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly oleFormat: Word.OleFormat; /** @@ -109672,16 +109421,14 @@ declare namespace Word { * Copies the field to the Clipboard. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ copyToClipboard(): void; /** * Removes the field from the document and places it on the Clipboard. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cut(): void; /** @@ -109695,8 +109442,7 @@ declare namespace Word { * Clicks the field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ doClick(): void; /** @@ -109735,8 +109481,7 @@ declare namespace Word { * Replaces the field with its most recent result. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unlink(): void; /** @@ -109750,8 +109495,7 @@ declare namespace Word { * Saves the changes made to the results of an {@link https://support.microsoft.com/office/1c34d6d6-0de3-4b5c-916a-2ff950fb629e | INCLUDETEXT field} back to the source document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ updateSource(): void; /** @@ -110327,8 +110071,7 @@ declare namespace Word { * Represents a heading style used in a table of contents or table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class HeadingStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -110337,16 +110080,14 @@ declare namespace Word { * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ level: number; /** * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name: string; /** @@ -110361,8 +110102,7 @@ declare namespace Word { * Deletes the heading style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete(): void; /** @@ -110404,8 +110144,7 @@ declare namespace Word { * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class HeadingStyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -110416,8 +110155,7 @@ declare namespace Word { * Adds a new heading style to a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param name The style name to be added. * @param level The heading level to assign. Must be a value from 1 to 9. @@ -111044,8 +110782,7 @@ declare namespace Word { * Represents the linking characteristics for an OLE object or picture. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class LinkFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -111054,56 +110791,49 @@ declare namespace Word { * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isAutoUpdated: boolean; /** * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLocked: boolean; /** * Specifies if the linked picture is saved with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPictureSavedWithDocument: boolean; /** * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sourceFullName: string; /** * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly sourceName: string; /** * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly sourcePath: string; /** * Gets the link type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly type: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; /** @@ -111118,8 +110848,7 @@ declare namespace Word { * Breaks the link between the source file and the OLE object, picture, or linked field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ breakLink(): void; /** @@ -111772,8 +111501,7 @@ declare namespace Word { * Specifies the name of the list template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name: string; /** @@ -111981,8 +111709,7 @@ declare namespace Word { * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class OleFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -111991,72 +111718,63 @@ declare namespace Word { * Specifies the class type for the specified OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ classType: string; /** * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconIndex: number; /** * Specifies the text displayed below the icon for the OLE object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconLabel: string; /** * Specifies the program file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconName: string; /** * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly iconPath: string; /** * Gets whether the specified object is displayed as an icon. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isDisplayedAsIcon: boolean; /** * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormattingPreservedOnUpdate: boolean; /** * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly label: string; /** * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly progId: string; /** @@ -112071,16 +111789,14 @@ declare namespace Word { * Activates the `OleFormat` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ activate(): void; /** * Sets the Windows registry value that determines the default application used to activate the specified OLE object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param classType The class type to activate as. */ @@ -112089,8 +111805,7 @@ declare namespace Word { * Requests that the OLE object perform one of its available verbs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param verbIndex Optional. The index of the verb to perform. */ @@ -112099,8 +111814,7 @@ declare namespace Word { * Requests that the OLE object perform one of its available verbs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param verbIndex Optional. The index of the verb to perform. */ @@ -112109,16 +111823,14 @@ declare namespace Word { * Opens the OLE object for editing in the application it was created in. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ edit(): void; /** * Opens the `OleFormat` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ open(): void; /** @@ -112335,8 +112047,7 @@ declare namespace Word { * Returns a `Selection` object that represents the current selection in the pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly selection: Word.Selection; /** @@ -112449,24 +112160,21 @@ declare namespace Word { * The options that define whether to save changes before closing and whether to route the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface WindowCloseOptions { /** * If provided, specifies whether to route the document to the next recipient. If the document doesn't have a routing slip attached, this property is ignored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ routeDocument?: boolean; /** * If provided, specifies the save action for the document. For available values, see {@link Word.SaveConfiguration}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ saveChanges?: Word.SaveConfiguration | "DoNotSaveChanges" | "SaveChanges" | "PromptToSaveChanges"; } @@ -112474,8 +112182,7 @@ declare namespace Word { * The options that scrolls a window or pane by the specified number of units defined by the calling method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface WindowScrollOptions { /** @@ -112483,8 +112190,7 @@ declare namespace Word { If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ down?: number; /** @@ -112492,8 +112198,7 @@ declare namespace Word { If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ left?: number; /** @@ -112501,8 +112206,7 @@ declare namespace Word { If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ right?: number; /** @@ -112510,8 +112214,7 @@ declare namespace Word { If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ up?: number; } @@ -112519,8 +112222,7 @@ declare namespace Word { * The options for scrolling through the specified pane or window page by page. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface WindowPageScrollOptions { /** @@ -112528,8 +112230,7 @@ declare namespace Word { If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ down?: number; /** @@ -112537,8 +112238,7 @@ declare namespace Word { If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ up?: number; } @@ -112562,8 +112262,7 @@ declare namespace Word { * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly next: Word.Window; /** @@ -112577,258 +112276,227 @@ declare namespace Word { * Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly previous: Word.Window; /** * Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly view: Word.View; /** * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areRulersDisplayed: boolean; /** * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areScreenTipsDisplayed: boolean; /** * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areThumbnailsDisplayed: boolean; /** * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ caption: string; /** * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly height: number; /** * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalPercentScrolled: number; /** * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** * Gets the position of an item in a collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly index: number; /** * Specifies whether the window is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isActive: boolean; /** * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDocumentMapVisible: boolean; /** * Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEnvelopeVisible: boolean; /** * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isHorizontalScrollBarDisplayed: boolean; /** * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLeftScrollBarDisplayed: boolean; /** * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isRightRulerDisplayed: boolean; /** * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSplit: boolean; /** * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVerticalRulerDisplayed: boolean; /** * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVerticalScrollBarDisplayed: boolean; /** * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVisible: boolean; /** * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly left: number; /** * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ splitVertical: number; /** - * Specifies the width of the style area in points. + * Specifies the state of the document window or task window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ + state: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + /** + * Specifies the width of the style area in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ styleAreaWidth: number; /** * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly top: number; /** * Gets the window type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly type: Word.WindowType | "Document" | "Template"; /** * Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly usableHeight: number; /** * Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly usableWidth: number; /** * Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ verticalPercentScrolled: number; /** * Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly width: number; /** * Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly windowNumber: number; - /** - * Specifies the state of the document window or task window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - windowState: Word.WindowState | "Normal" | "Maximize" | "Minimize"; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. @@ -112841,16 +112509,14 @@ declare namespace Word { * Activates the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ activate(): void; /** * Closes the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. The options that define whether to save changes before closing and whether to route the document. */ @@ -112859,8 +112525,7 @@ declare namespace Word { * Scrolls the window by the specified number of screens. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. The options for scrolling the window by the specified number of screens. If no options are specified, the window is scrolled down one screen. */ @@ -112869,8 +112534,7 @@ declare namespace Word { * Scrolls through the window page by page. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. The options for scrolling through the window page by page. */ @@ -112879,16 +112543,14 @@ declare namespace Word { * Sets the focus of the document window to the body of an email message. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ setFocus(): void; /** * Scrolls the window by the specified number of lines. A "line" corresponds to the distance scrolled by clicking the scroll arrow on the scroll bar once. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. The options for scrolling the window by the specified number of lines. If no options are specified, the window is scrolled down by one line. */ @@ -112897,8 +112559,7 @@ declare namespace Word { * Shows or hides the ribbon. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ toggleRibbon(): void; /** @@ -113292,8 +112953,7 @@ declare namespace Word { * Removes any spacing before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ closeUp(): void; /** @@ -113442,16 +113102,14 @@ declare namespace Word { * Indents the paragraph by one level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ indent(): void; /** * Indents the paragraph by a specified number of characters. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param count The number of characters for the indent. */ @@ -113460,8 +113118,7 @@ declare namespace Word { * Indents the first line of the paragraph by the specified number of characters. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param count The number of characters for the first line indent. */ @@ -113627,16 +113284,14 @@ declare namespace Word { * Joins a list paragraph with the closest list above or below this paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ joinList(): void; /** * Returns a `Paragraph` object that represents the next paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param count Optional. The number of paragraphs to move forward. */ @@ -113645,56 +113300,49 @@ declare namespace Word { * Toggles the spacing before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ openOrCloseUp(): void; /** * Sets spacing before the paragraph to 12 points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ openUp(): void; /** * Removes one level of indent for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ outdent(): void; /** * Applies the next heading level style (Heading 1 through Heading 8) to the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ outlineDemote(): void; /** * Demotes the paragraph to body text by applying the Normal style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ outlineDemoteToBody(): void; /** * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ outlinePromote(): void; /** * Returns the previous paragraph as a `Paragraph` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param count Optional. The number of paragraphs to move backward. */ @@ -113703,16 +113351,14 @@ declare namespace Word { * Removes manual paragraph formatting (formatting not applied using a style). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ reset(): void; /** * Resets the paragraph that uses custom list levels to the original level settings. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ resetAdvanceTo(): void; /** @@ -113755,40 +113401,35 @@ declare namespace Word { * Selects the number or bullet in a list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectNumber(): void; /** * Separates a list into two separate lists. For numbered lists, the new list restarts numbering at the starting number, usually 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ separateList(): void; /** * Sets the paragraph to single spacing. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ space1(): void; /** * Sets the paragraph to 1.5-line spacing. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ space1Pt5(): void; /** * Sets the paragraph to double spacing. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ space2(): void; /** @@ -113813,8 +113454,7 @@ declare namespace Word { * Sets a hanging indent to a specified number of tab stops. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param count The number of tab stops for the hanging indent. */ @@ -113823,8 +113463,7 @@ declare namespace Word { * Sets the left indent for the paragraph to a specified number of tab stops. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param count The number of tab stops for the left indent. */ @@ -113929,8 +113568,7 @@ declare namespace Word { * Returns a `Paragraph` object that represents a new, blank paragraph added to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range before which you want the new paragraph to be added. The new paragraph doesn't replace the range. */ @@ -113939,16 +113577,14 @@ declare namespace Word { * Removes any spacing before the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ closeUp(): void; /** * Decreases the spacing before and after paragraphs in six-point increments. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ decreaseSpacing(): void; /** @@ -113983,24 +113619,21 @@ declare namespace Word { * Increases the spacing before and after paragraphs in six-point increments. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ increaseSpacing(): void; /** * Indents the paragraphs by one level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ indent(): void; /** * Indents the paragraphs in the collection by the specified number of characters. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param count The number of characters by which the specified paragraphs are to be indented. */ @@ -114009,8 +113642,7 @@ declare namespace Word { * Indents the first line of the paragraphs in the collection by the specified number of characters. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param count The number of characters by which the first line of each specified paragraph is to be indented. */ @@ -114019,80 +113651,70 @@ declare namespace Word { * Toggles spacing before paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ openOrCloseUp(): void; /** * Sets spacing before the specified paragraphs to 12 points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ openUp(): void; /** * Removes one level of indent for the paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ outdent(): void; /** * Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ outlineDemote(): void; /** * Demotes the specified paragraphs to body text by applying the Normal style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ outlineDemoteToBody(): void; /** * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ outlinePromote(): void; /** * Sets the specified paragraphs to single spacing. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ space1(): void; /** * Sets the specified paragraphs to 1.5-line spacing. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ space1Pt5(): void; /** * Sets the specified paragraphs to double spacing. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ space2(): void; /** * Sets a hanging indent to the specified number of tab stops. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param count The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ @@ -114101,8 +113723,7 @@ declare namespace Word { * Sets the left indent for the specified paragraphs to the specified number of tab stops. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param count The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ @@ -114302,24 +113923,21 @@ declare namespace Word { * Returns a `BookmarkCollection` object that represents all the bookmarks in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly bookmarks: Word.BookmarkCollection; /** * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly borders: Word.BorderUniversalCollection; /** * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly conflicts: Word.ConflictCollection; /** @@ -114333,8 +113951,7 @@ declare namespace Word { * Returns an `EditorCollection` object that represents all the users authorized to modify the range when the document is in protected (read-only) mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly editors: Word.EditorCollection; /** @@ -114469,8 +114086,7 @@ declare namespace Word { * Gets the collection of revisions that represents the tracked changes in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly revisions: Word.RevisionCollection; /** @@ -114514,80 +114130,70 @@ declare namespace Word { * Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly bold: boolean; /** * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly boldBidirectional: boolean; /** * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ case: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** * Specifies the character width of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ characterWidth: Word.CharacterWidth | "Half" | "Full"; /** * Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ combineCharacters: boolean; /** * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly disableCharacterSpaceGrid: boolean; /** * Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** * Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end: number; /** * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitTextWidth: number; /** * Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grammarChecked: boolean; /** @@ -114601,16 +114207,14 @@ declare namespace Word { * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly highlightColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** * Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalInVertical: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** @@ -114624,8 +114228,7 @@ declare namespace Word { * Specifies the ID for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id: string; /** @@ -114639,40 +114242,35 @@ declare namespace Word { * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isEndOfRowMark: boolean; /** * Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isTextVisibleOnScreen: boolean; /** * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly italic: boolean; /** * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly italicBidirectional: boolean; /** * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ kana: Word.Kana | "Katakana" | "Hiragana"; /** @@ -114707,40 +114305,35 @@ declare namespace Word { * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showAll: boolean; /** * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spellingChecked: boolean; /** * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start: number; /** * Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly storyLength: number; /** * Gets the story type for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** @@ -114768,8 +114361,7 @@ declare namespace Word { * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ twoLinesInOne: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; /** @@ -114779,7 +114371,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly underline: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; + readonly underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. @@ -116514,8 +116106,7 @@ declare namespace Word { * Returns the `TableColumnCollection` object that represents the columns in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly columns: Word.TableColumnCollection; /** @@ -116606,8 +116197,7 @@ declare namespace Word { * Returns the `ShadingUniversal` object that represents the shading of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly shading: Word.ShadingUniversal; /** @@ -116628,8 +116218,7 @@ declare namespace Word { * Specifies the description of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ description: string; /** @@ -116727,8 +116316,7 @@ declare namespace Word { * Specifies the title of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ title: string; /** @@ -116786,8 +116374,7 @@ declare namespace Word { * Applies the specified style but maintains any formatting that a user directly applies. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param styleName The name of the style to apply. */ @@ -116796,8 +116383,7 @@ declare namespace Word { * Determines how Microsoft Word resizes a table when the AutoFit feature is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param behavior How Word resizes the specified table with the AutoFit feature is used. */ @@ -116806,8 +116392,7 @@ declare namespace Word { * Determines how Microsoft Word resizes a table when the AutoFit feature is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param behavior How Word resizes the specified table with the AutoFit feature is used. */ @@ -116823,8 +116408,7 @@ declare namespace Word { * Applies a predefined look to a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. An object that specifies the options for applying the table format. */ @@ -116840,8 +116424,7 @@ declare namespace Word { * Converts a table to text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. An object that specifies the options for converting the table to text. * @returns A `Range` object that represents the converted text. @@ -117033,8 +116616,7 @@ declare namespace Word { * Updates the table with the characteristics of the predefined table format set when the `autoFormat` method was called. The default predefined format is {@link Word.TableFormatType | TableFormatType.none}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ reapplyAutoFormat(): void; /** @@ -117097,8 +116679,7 @@ declare namespace Word { * Sorts the specified table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. An object that specifies the options for sorting the table. */ @@ -117151,16 +116732,14 @@ declare namespace Word { * Returns a `BorderUniversalCollection` that represents all the borders for the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly borders: Word.BorderUniversalCollection; /** * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly shading: Word.Shading; /** @@ -117195,16 +116774,14 @@ declare namespace Word { * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columnStripe: number; /** * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isBreakAcrossPagesAllowed: boolean; /** @@ -117218,8 +116795,7 @@ declare namespace Word { * Specifies the left indent value (in points) for the rows in the table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftIndent: number; /** @@ -117233,16 +116809,14 @@ declare namespace Word { * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rowStripe: number; /** * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** @@ -117264,8 +116838,7 @@ declare namespace Word { * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param conditionCode The area of the table to which to apply the formatting. */ @@ -117274,8 +116847,7 @@ declare namespace Word { * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param conditionCode The area of the table to which to apply the formatting. */ @@ -117319,8 +116891,7 @@ declare namespace Word { * Represents a tab stop in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class TabStop extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -117329,56 +116900,49 @@ declare namespace Word { * Gets the next tab stop in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly next: Word.TabStop; /** * Gets the previous tab stop in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly previous: Word.TabStop; /** * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly alignment: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** * Gets whether this tab stop is a custom tab stop. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly customTab: boolean; /** * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly leader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly position: number; /** * Removes this custom tab stop. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ clear(): void; /** @@ -117420,8 +116984,7 @@ declare namespace Word { * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class TabStopCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -117432,8 +116995,7 @@ declare namespace Word { * Returns a `TabStop` object that represents a custom tab stop added to the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param position The position of the tab stop. * @param options Optional. The options to further configure the new tab stop. @@ -117443,8 +117005,7 @@ declare namespace Word { * Returns the next `TabStop` object to the right of the specified position. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param Position The position to check. */ @@ -117453,8 +117014,7 @@ declare namespace Word { * Returns the next `TabStop` object to the left of the specified position. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param Position The position to check. */ @@ -117463,8 +117023,7 @@ declare namespace Word { * Clears all the custom tab stops from the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ clearAll(): void; /** @@ -117513,24 +117072,21 @@ declare namespace Word { * Specifies the options for adding to a {@link Word.TabStopCollection} object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TabStopAddOptions { /** * If provided, specifies the alignment of the tab stop. The default value is `left`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** * If provided, specifies the leader character for the tab stop. The default value is `spaces`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; } @@ -117860,8 +117416,7 @@ declare namespace Word { * Represents a table of authorities in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class TableOfAuthorities extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -117870,16 +117425,14 @@ declare namespace Word { * Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bookmark: string; /** @@ -117887,80 +117440,70 @@ declare namespace Word { 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ category: number; /** * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entrySeparator: string; /** * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isCategoryHeaderIncluded: boolean; /** * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEntryFormattingKept: boolean; /** * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPassimUsed: boolean; /** * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageNumberSeparator: string; /** * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageRangeSeparator: string; /** * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceName: string; /** * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceSeparator: string; /** * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** @@ -117975,8 +117518,7 @@ declare namespace Word { * Deletes this table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete(): void; /** @@ -118018,8 +117560,7 @@ declare namespace Word { * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class TableOfAuthoritiesCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -118030,8 +117571,7 @@ declare namespace Word { * Adds a table of authorities to the document at the specified range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range where the table of authorities will appear. The table of authorities replaces the range if the range isn't collapsed. * @param options Optional. The options to configure the table of authorities. @@ -118041,8 +117581,7 @@ declare namespace Word { * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} after all instances of the specified citation text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param shortCitation The citation text to mark. * @param options Optional. The options for marking the citation. @@ -118052,8 +117591,7 @@ declare namespace Word { * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} at the specified range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range where the citation will be inserted. * @param shortCitation The short citation text. @@ -118064,8 +117602,7 @@ declare namespace Word { * Finds and selects the next instance of the specified citation text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param shortCitation The citation text to search for. */ @@ -118106,8 +117643,7 @@ declare namespace Word { * Specifies the options for adding to a {@link Word.TableOfAuthoritiesCollection} object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfAuthoritiesAddOptions { /** @@ -118116,8 +117652,7 @@ declare namespace Word { Corresponds to the `\b` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bookmark?: string; /** @@ -118127,8 +117662,7 @@ declare namespace Word { The default value is `1`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ category?: number; /** @@ -118137,8 +117671,7 @@ declare namespace Word { If omitted, no separator is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entrySeparator?: string; /** @@ -118147,8 +117680,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ includeCategoryHeader?: boolean; /** @@ -118157,8 +117689,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ keepEntryFormatting?: boolean; /** @@ -118167,8 +117698,7 @@ declare namespace Word { If omitted, a comma and a space (", ") are used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageNumberSeparator?: string; /** @@ -118177,8 +117707,7 @@ declare namespace Word { If omitted, an en dash ("–") is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageRangeSeparator?: string; /** @@ -118186,8 +117715,7 @@ declare namespace Word { Corresponds to the `\s` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceName?: string; /** @@ -118196,8 +117724,7 @@ declare namespace Word { If omitted, a hyphen ("-") is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceSeparator?: string; /** @@ -118206,8 +117733,7 @@ declare namespace Word { The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ usePassim?: boolean; } @@ -118215,8 +117741,7 @@ declare namespace Word { * Specifies the options for inserting a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfAuthoritiesMarkCitationOptions { /** @@ -118226,24 +117751,21 @@ declare namespace Word { To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ category?: number; /** * If provided, specifies the long citation for the entry as it will appear in a table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ longCitation?: string; /** * If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ longCitationAutoText?: string; } @@ -118251,8 +117773,7 @@ declare namespace Word { * Represents a category used in a table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class TableOfAuthoritiesCategory extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -118262,8 +117783,7 @@ declare namespace Word { Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly name: string; /** @@ -118305,8 +117825,7 @@ declare namespace Word { * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class TableOfAuthoritiesCategoryCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -118317,16 +117836,14 @@ declare namespace Word { * Returns the number of items in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ getCount(): OfficeExtension.ClientResult; /** * Returns a `TableOfAuthoritiesCategory` object that represents the specified item in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param index The index of the item to retrieve. */ @@ -118367,8 +117884,7 @@ declare namespace Word { * Represents a table of contents in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class TableOfContents extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -118377,96 +117893,84 @@ declare namespace Word { * Gets the additional styles used for the table of contents. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** * Gets the portion of a document that is this table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBuiltInHeadingStylesUsed: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldsUsed: boolean; /** * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areHyperlinksUsedOnWeb: boolean; /** * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersHiddenOnWeb: boolean; /** * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersIncluded: boolean; /** * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersRightAligned: boolean; /** * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel: number; /** * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId: string; /** * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel: number; /** @@ -118481,22 +117985,19 @@ declare namespace Word { * Deletes this table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete(): void; /** * Updates the entire table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] /** * Updates only the page numbers for items in this table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ updatePageNumbers(): void; /** @@ -118538,8 +118039,7 @@ declare namespace Word { * Represents a collection of {@link Word.TableOfContents} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class TableOfContentsCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -118550,8 +118050,7 @@ declare namespace Word { * Adds a table of contents to the document at the specified range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range where the table of contents will be added. The table of contents replaces the range if the range isn't collapsed. * @param options Optional. The options for configuring the table of contents. @@ -118561,8 +118060,7 @@ declare namespace Word { * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range where the entry will be inserted. * @param options Optional. The options for marking the table of contents entry. @@ -118604,8 +118102,7 @@ declare namespace Word { * Specifies the options for adding to a {@link Word.TableOfContentsCollection} object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfContentsAddOptions { /** @@ -118613,8 +118110,7 @@ declare namespace Word { Use {@link Word.HeadingStyleCollection | HeadingStyleCollection.add} to create new heading styles. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ addedStyles?: string; /** @@ -118622,8 +118118,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hidePageNumbersOnWeb?: boolean; /** @@ -118631,8 +118126,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ includePageNumbers?: boolean; /** @@ -118641,8 +118135,7 @@ declare namespace Word { The default value is `9`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel?: number; /** @@ -118650,8 +118143,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightAlignPageNumbers?: boolean; /** @@ -118660,8 +118152,7 @@ declare namespace Word { If this argument is omitted, TC fields aren't used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: string; /** @@ -118670,8 +118161,7 @@ declare namespace Word { The default value is `1`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel?: number; /** @@ -118679,8 +118169,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useBuiltInHeadingStyles?: boolean; /** @@ -118689,8 +118178,7 @@ declare namespace Word { The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useFields?: boolean; /** @@ -118698,8 +118186,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useHyperlinksOnWeb?: boolean; /** @@ -118707,8 +118194,7 @@ declare namespace Word { The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useOutlineLevels?: boolean; } @@ -118716,8 +118202,7 @@ declare namespace Word { * Specifies the options for inserting a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfContentsMarkEntryOptions { /** @@ -118726,8 +118211,7 @@ declare namespace Word { When the `entryAutoText` property is set, this property is ignored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entry?: string; /** @@ -118735,24 +118219,21 @@ declare namespace Word { When this property is used, the `entry` property is ignored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entryAutoText?: string; /** * If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ level?: number; /** * If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration"). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: string; } @@ -118760,8 +118241,7 @@ declare namespace Word { * Represents a table of figures in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class TableOfFigures extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -118770,112 +118250,98 @@ declare namespace Word { * Gets the additional styles used for the table of figures. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** * Gets the portion of a document that is this table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBuiltInHeadingStylesUsed: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldsUsed: boolean; /** * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areHyperlinksUsedOnWeb: boolean; /** * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersHiddenOnWeb: boolean; /** * Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersIncluded: boolean; /** * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersRightAligned: boolean; /** * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ captionLabel: string; /** * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLabelIncluded: boolean; /** * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel: number; /** * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId: string; /** * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel: number; /** @@ -118890,22 +118356,19 @@ declare namespace Word { * Deletes this table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete(): void; /** * Updates the entire table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] /** * Updates only the page numbers for items in this table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ updatePageNumbers(): void; /** @@ -118947,8 +118410,7 @@ declare namespace Word { * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class TableOfFiguresCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -118959,8 +118421,7 @@ declare namespace Word { * Adds a table of figures to the document at the specified range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range where the table of figures will be added. The table of figures replaces the range if the range isn't collapsed. * @param options Optional. The options for configuring the table of figures. @@ -118970,8 +118431,7 @@ declare namespace Word { * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range for marking entries in a table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range where the TC field will be inserted. * @param options Optional. The options for marking the entry. @@ -119013,16 +118473,14 @@ declare namespace Word { * Specifies the options for adding to a {@link Word.TableOfFiguresCollection} object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfFiguresAddOptions { /** * If provided, specifies the string names of additional styles to use for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ addedStyles?: string; /** @@ -119031,8 +118489,7 @@ declare namespace Word { The default value is "Figure". * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ captionLabel?: string; /** @@ -119040,8 +118497,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hidePageNumbersOnWeb?: boolean; /** @@ -119049,8 +118505,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ includeLabel?: boolean; /** @@ -119058,8 +118513,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ includePageNumbers?: boolean; /** @@ -119068,8 +118522,7 @@ declare namespace Word { The default value is `9`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel?: number; /** @@ -119077,8 +118530,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightAlignPageNumbers?: boolean; /** @@ -119086,8 +118538,7 @@ declare namespace Word { Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: string; /** @@ -119096,8 +118547,7 @@ declare namespace Word { The default value is `1`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel?: number; /** @@ -119105,8 +118555,7 @@ declare namespace Word { The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useBuiltInHeadingStyles?: boolean; /** @@ -119115,8 +118564,7 @@ declare namespace Word { The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useFields?: boolean; /** @@ -119124,8 +118572,7 @@ declare namespace Word { The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useHyperlinksOnWeb?: boolean; } @@ -119184,16 +118631,14 @@ declare namespace Word { * Returns the `Range` object that represents the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Returns the `ShadingUniversal` object that represents the shading of the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly shading: Word.ShadingUniversal; /** @@ -119271,8 +118716,7 @@ declare namespace Word { * Converts the table row to text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. An object that specifies the options for converting the table row to text. */ @@ -119419,8 +118863,7 @@ declare namespace Word { * Sets the height of the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param rowHeight The height of the row, in points. * @param heightRule The rule for determining the height of the table row. @@ -119430,8 +118873,7 @@ declare namespace Word { * Sets the height of the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param rowHeight The height of the row, in points. * @param heightRule The rule for determining the height of the table row. @@ -119441,8 +118883,7 @@ declare namespace Word { * Sets the left indent for the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param leftIndent The distance (in points) between the current left edge of the table row and the desired left edge. * @param rulerStyle The ruler style to apply. @@ -119452,8 +118893,7 @@ declare namespace Word { * Sets the left indent for the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param leftIndent The distance (in points) between the current left edge of the table row and the desired left edge. * @param rulerStyle The ruler style to apply. @@ -119509,8 +118949,7 @@ declare namespace Word { * Converts rows in a table to text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. An object that specifies the options for converting the table rows to text. * @returns A `Range` object that represents the converted text. @@ -119520,16 +118959,14 @@ declare namespace Word { * Deletes the table rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete(): void; /** * Adjusts the height of the rows so that they're equal. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ distributeHeight(): void; /** @@ -119550,16 +118987,14 @@ declare namespace Word { * Selects the table rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ select(): void; /** * Sets the height of the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param rowHeight The height of the row, in points. * @param heightRule The rule for determining the height of the specified rows. @@ -119569,8 +119004,7 @@ declare namespace Word { * Sets the height of the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param rowHeight The height of the row, in points. * @param heightRule The rule for determining the height of the specified rows. @@ -119580,8 +119014,7 @@ declare namespace Word { * Sets the left indent for the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param leftIndent The distance (in points) between the current left edge of the specified rows and the desired left edge. * @param rulerStyle The ruler style to apply. @@ -119591,8 +119024,7 @@ declare namespace Word { * Sets the left indent for the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param leftIndent The distance (in points) between the current left edge of the specified rows and the desired left edge. * @param rulerStyle The ruler style to apply. @@ -119650,8 +119082,7 @@ declare namespace Word { * Returns the `TableColumn` object that represents the table column that contains this cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly column: Word.TableColumn; /** @@ -119672,8 +119103,7 @@ declare namespace Word { * Returns the `ShadingUniversal` object that represents the shading of the table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly shading: Word.ShadingUniversal; /** @@ -119744,16 +119174,14 @@ declare namespace Word { * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that calculates and displays the sum of the values in table cells above or to the left of the cell specified in the expression. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ autoSum(): void; /** * Deletes the table cell and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ @@ -119776,8 +119204,7 @@ declare namespace Word { * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that contains the specified formula into a table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. An object that specifies the options for the formula. */ @@ -119858,8 +119285,7 @@ declare namespace Word { * Merges this table cell with the specified table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param mergeTo The cell to be merged with. */ @@ -119868,8 +119294,7 @@ declare namespace Word { * Selects the table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ select(): void; /** @@ -119952,16 +119377,14 @@ declare namespace Word { * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ autoFit(): void; /** * Deletes the table cells and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ @@ -119970,8 +119393,7 @@ declare namespace Word { * Deletes the table cells and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ @@ -119980,16 +119402,14 @@ declare namespace Word { * Adjusts the height of the specified cells so that they are equal. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ distributeHeight(): void; /** * Adjusts the width of the specified cells so that they are equal. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ distributeWidth(): void; /** @@ -120010,16 +119430,14 @@ declare namespace Word { * Merges the specified cells into a single cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ merge(): void; /** * Sets the height of the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param rowHeight The height of the row to set, in points. * @param heightRule The rule for determining the height of the specified rows. @@ -120029,8 +119447,7 @@ declare namespace Word { * Sets the height of the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param rowHeight The height of the row to set, in points. * @param heightRule The rule for determining the height of the specified rows. @@ -120040,8 +119457,7 @@ declare namespace Word { * Sets the width of the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param columnWidth The width of the row to set, in points. * @param rulerStyle The ruler style to apply. @@ -120051,8 +119467,7 @@ declare namespace Word { * Sets the width of the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param columnWidth The width of the row to set, in points. * @param rulerStyle The ruler style to apply. @@ -120062,8 +119477,7 @@ declare namespace Word { * Splits this range of table cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for splitting the table cells. */ @@ -120200,8 +119614,7 @@ declare namespace Word { * Returns a `ListTemplateCollection` object that represents all the list templates in the template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly listTemplates: Word.ListTemplateCollection; /** @@ -120604,8 +120017,7 @@ declare namespace Word { * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class View extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -120614,416 +120026,364 @@ declare namespace Word { * Gets the instance of a `RevisionsFilter` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly revisionsFilter: Word.RevisionsFilter; /** * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areAllNonprintingCharactersDisplayed: boolean; /** * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBackgroundsDisplayed: boolean; /** * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areBookmarksIndicated: boolean; /** * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areCommentsDisplayed: boolean; /** * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areConnectingLinesToRevisionsBalloonDisplayed: boolean; /** * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areCropMarksDisplayed: boolean; /** * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areDrawingsDisplayed: boolean; /** * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areEditableRangesShaded: boolean; /** * Specifies whether field codes are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldCodesDisplayed: boolean; /** * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFormatChangesDisplayed: boolean; /** * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areInkAnnotationsDisplayed: boolean; /** * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areInsertionsAndDeletionsDisplayed: boolean; /** * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areLinesWrappedToWindow: boolean; /** * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areObjectAnchorsDisplayed: boolean; /** * Gets whether Microsoft Word displays optional line breaks. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areOptionalBreaksDisplayed: boolean; /** * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areOptionalHyphensDisplayed: boolean; /** * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areOtherAuthorsVisible: boolean; /** * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly arePageBoundariesDisplayed: boolean; /** * Gets whether paragraph marks are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areParagraphsMarksDisplayed: boolean; /** * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly arePicturePlaceholdersDisplayed: boolean; /** * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areRevisionsAndCommentsDisplayed: boolean; /** * Gets whether space characters are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areSpacesIndicated: boolean; /** * Specifies whether table gridlines are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTableGridlinesDisplayed: boolean; /** * Gets whether tab characters are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areTabsDisplayed: boolean; /** * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly areTextBoundariesDisplayed: boolean; /** * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** * Gets on-screen shading for fields. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDraft: boolean; /** * Specifies whether only the first line of body text is shown in outline view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFirstLineOnlyDisplayed: boolean; /** * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormatDisplayed: boolean; /** * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFullScreen: boolean; /** * Gets whether text formatted as hidden text is displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isHiddenTextDisplayed: boolean; /** * Gets whether highlight formatting is displayed and printed with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isHighlightingDisplayed: boolean; /** * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInConflictMode: boolean; /** * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInPanning: boolean; /** * Specifies whether the document is being viewed in reading layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInReadingLayout: boolean; /** * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMailMergeDataView: boolean; /** * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMainTextLayerVisible: boolean; /** * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPointerShownAsMagnifier: boolean; /** * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isReadingLayoutActualView: boolean; /** * Specifies whether XML tags are visible in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isXmlMarkupVisible: boolean; /** * Specifies the display mode for tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; /** * Specifies the page movement type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide"; /** * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; /** * Specifies the width of the revision balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsBalloonWidth: number; /** * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** * Specifies the document element displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** * Specifies the active window pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** * Specifies the view type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; /** @@ -121038,16 +120398,14 @@ declare namespace Word { * Collapses all the headings in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ collapseAllHeadings(): void; /** * Collapses the text under the selection or the specified range by one heading level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range A `Range` object that specifies the range to collapse. */ @@ -121056,16 +120414,14 @@ declare namespace Word { * Expands all the headings in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ expandAllHeadings(): void; /** * Expands the text under the selection by one heading level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range A `Range` object that specifies the range to expand. */ @@ -121074,32 +120430,28 @@ declare namespace Word { * Moves to the next header or footer, depending on whether a header or footer is displayed in the view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ nextHeaderFooter(): void; /** * Moves to the previous header or footer, depending on whether a header or footer is displayed in the view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previousHeaderFooter(): void; /** * Switches between showing all text (headings and body text) and showing only headings. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showAllHeadings(): void; /** * Shows all headings up to the specified heading level and hides subordinate headings and body text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param level The heading level to show. */ @@ -122066,8 +121418,7 @@ declare namespace Word { * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class Reviewer extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -122076,8 +121427,7 @@ declare namespace Word { * Specifies if the `Reviewer` object is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVisible: boolean; /** @@ -122127,8 +121477,7 @@ declare namespace Word { * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class ReviewerCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -122181,8 +121530,7 @@ declare namespace Word { * Represents the current settings related to the display of reviewers' comments and revision marks in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class RevisionsFilter extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -122191,24 +121539,21 @@ declare namespace Word { * Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly reviewers: Word.ReviewerCollection; /** * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ markup: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ view: Word.RevisionsView | "Final" | "Original"; /** @@ -122223,8 +121568,7 @@ declare namespace Word { * Shows or hides all revisions in the document that contain comments and tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ toggleShowAllReviewers(): void; /** @@ -122396,8 +121740,7 @@ declare namespace Word { * Represents a single tracked change in a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class Revision extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -122406,56 +121749,49 @@ declare namespace Word { * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly movedRange: Word.Range; /** * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Gets the name of the user who made the tracked change. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly author: string; /** * Gets the date and time when the tracked change was made. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly date: Date; /** * Gets the description of tracked formatting changes in the revision. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly formatDescription: string; /** * Gets a number that represents the position of this item in a collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly index: number; /** * Gets the revision type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; /** @@ -122470,16 +121806,14 @@ declare namespace Word { * Accepts the tracked change, removes the revision mark, and incorporates the change into the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ accept(): void; /** * Rejects the tracked change. The revision marks are removed, leaving the original text intact. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ reject(): void; /** @@ -122521,8 +121855,7 @@ declare namespace Word { * A collection of {@link Word.Revision} objects that represent the changes marked with revision marks in a range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class RevisionCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -122533,8 +121866,7 @@ declare namespace Word { * Accepts all the tracked changes in the document or range, removes all revision marks, and incorporates the changes into the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ acceptAll(): void; /** @@ -122551,8 +121883,7 @@ declare namespace Word { * Rejects all the tracked changes in the document or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rejectAll(): void; /** @@ -123402,7 +122733,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly xmlapping: Word.XmlMapping; + readonly xmlMapping: Word.XmlMapping; /** * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * @@ -123566,8 +122897,7 @@ declare namespace Word { * Represents one of the readability statistics for the document or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class ReadabilityStatistic extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -123576,16 +122906,14 @@ declare namespace Word { * Returns the name of the readability statistic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly name: string; /** * Returns the value of the grammar statistic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly value: number; /** @@ -123627,8 +122955,7 @@ declare namespace Word { * Represents a collection of {@link Word.ReadabilityStatistic} objects for the document or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class ReadabilityStatisticCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -123639,8 +122966,7 @@ declare namespace Word { * Gets the readability statistic at the specified index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param index The zero-based index of the item to retrieve. */ @@ -123681,8 +123007,7 @@ declare namespace Word { * Represents the settings for saving a Word document as a webpage. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class WebSettings extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -123691,88 +123016,77 @@ declare namespace Word { * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ allowPng: boolean; /** * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ encoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly folderSuffix: string; /** * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ organizeInFolder: boolean; /** * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pixelsPerInch: number; /** * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ relyOnCSS: boolean; /** * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ relyOnVectorMarkupLanguage: boolean; /** * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ screenSize: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** * Specifies the target browser for documents viewed in a web browser. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ targetBrowser: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useLongFileNames: boolean; /** * Sets the folder suffix for the specified document to the default suffix for the language support you have selected or installed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useDefaultFolderSuffix(): void; /** @@ -123814,8 +123128,7 @@ declare namespace Word { * Represents the collection of {@link Word.XmlNode} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class XmlNodeCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -123836,8 +123149,7 @@ declare namespace Word { * Returns an individual `XmlNode` object in a collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param index The index of the item to retrieve. */ @@ -123878,24 +123190,21 @@ declare namespace Word { * Provides configuration options for the {@link Word.XmlNode | XmlNode.setValidationError} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface XmlNodeSetValidationErrorOptions { /** * If provided, specifies whether the validation error should be cleared automatically. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ clearedAutomatically?: boolean; /** * If provided, specifies the error text to display for the validation error. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ errorText?: string; } @@ -123903,8 +123212,7 @@ declare namespace Word { * Represents a single XML node applied to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class XmlNode extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -123913,184 +123221,163 @@ declare namespace Word { * Gets the attributes for this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly attributes: Word.XmlNodeCollection; /** * Gets the child elements of this XML node. Returns an empty collection if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly childNodes: Word.XmlNodeCollection; /** * Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly firstChild: Word.XmlNode; /** * Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly lastChild: Word.XmlNode; /** * Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly nextSibling: Word.XmlNode; /** * Gets the parent document of this XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly ownerDocument: Word.Document; /** * Gets the parent element of this XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly parentNode: Word.XmlNode; /** * Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly previousSibling: Word.XmlNode; /** * Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Gets the name of the element without any prefix. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly baseName: string; /** * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly hasChildNodes: boolean; /** * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly level: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly namespaceUri: string; /** - * Gets the type of node. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - readonly nodeType: Word.XmlNodeType | "Element" | "Attribute"; + placeholderText: string; /** - * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - nodeValue: string; + text: string; /** - * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. + * Gets the type of node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText: string; + readonly type: Word.XmlNodeType | "Element" | "Attribute"; /** - * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - text: string; + readonly validationErrorText: string; /** - * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - readonly validationErrorText: string; + readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom"; /** - * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom"; + value: string; /** * Copies this XML node, excluding XML markup, to the Clipboard. For attribute nodes, copies only the attribute value as text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ copy(): void; /** * Removes this XML node from the document and places it on the Clipboard. For attribute nodes, removes the attribute from its parent element and copies only the attribute value as text to the clipboard. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cut(): void; /** * Deletes the XML node from the XML document. For element nodes, removes the entire element and its content; for attribute nodes, removes the attribute from its parent element. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete(): void; /** * Removes a child element from this XML node. This method has no effect if the node type is `attribute` (since attribute nodes have no child elements). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param childElement The child element to remove. */ @@ -124099,8 +123386,7 @@ declare namespace Word { * Returns all the child elements that match the XPath parameter, in the order in which they appear within this XML node. Returns `null` if the node type is `attribute` (since attribute nodes have no child elements to search). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param xPath The XPath expression to evaluate. * @param options Optional. Configuration options for the XPath search. @@ -124111,8 +123397,7 @@ declare namespace Word { * Returns the first child element that matches the XPath parameter within this XML node. Returns `null` if the node type is `attribute` (since attribute nodes have no child elements to search). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param xPath The XPath expression to evaluate. * @param options Optional. Configuration options for the XPath search. @@ -124123,8 +123408,7 @@ declare namespace Word { * Changes the validation error text displayed to a user for this XML node and whether to force Word to report the node as invalid. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param status The validation status to set. * @param options Optional. Configuration options for setting the validation error. @@ -124134,8 +123418,7 @@ declare namespace Word { * Changes the validation error text displayed to a user for this XML node and whether to force Word to report the node as invalid. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param status The validation status to set. * @param options Optional. Configuration options for setting the validation error. @@ -124145,8 +123428,7 @@ declare namespace Word { * Validates this XML node against the XML schemas that are attached to the document. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ validate(): void; /** @@ -124188,22 +123470,19 @@ declare namespace Word { * Specifies the type of an XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum XmlNodeType { /** * Element node. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ element = "Element", /** * Attribute node. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ attribute = "Attribute", } @@ -124211,22 +123490,19 @@ declare namespace Word { * Specifies the validation status of an XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum XmlValidationStatus { /** * The node is valid. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ok = "Ok", /** * The node has a custom (user-defined) validation error. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ custom = "Custom", } @@ -124234,36 +123510,31 @@ declare namespace Word { * Specifies the level of an XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum XmlNodeLevel { /** * Inline node level. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ inline = "Inline", /** * Paragraph node level. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ paragraph = "Paragraph", /** * Row node level. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ row = "Row", /** * Cell node level. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cell = "Cell", } @@ -124271,22 +123542,19 @@ declare namespace Word { * Specifies which Quick Style set to apply to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ApplyQuickStyleSet { /** * Resets the Quick Style to the style set in use when the document was opened. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sessionStart = "SessionStart", /** * Resets the Quick Style to the style set from the template, if any. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ template = "Template", } @@ -124294,24 +123562,21 @@ declare namespace Word { * Provides configuration options for the {@link Word.XmlNode | XmlNode.selectNodes} and {@link Word.Document| Document.selectNodes} methods. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectNodesOptions { /** * If provided, specifies whether to skip text nodes in the search. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fastSearchSkippingTextNodes?: boolean; /** * If provided, specifies the prefix mapping for the XPath expression. The default value is "" (empty string). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ prefixMapping?: string; } @@ -124319,24 +123584,21 @@ declare namespace Word { * Provides configuration options for the {@link Word.XmlNode | XmlNode.selectSingleNode} and {@link Word.Document| Document.selectSingleNode} methods. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectSingleNodeOptions { /** * If provided, specifies whether to skip text nodes in the search. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fastSearchSkippingTextNodes?: boolean; /** * If provided, specifies the prefix mapping for the XPath expression. The default value is "" (empty string). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ prefixMapping?: string; } @@ -124344,85 +123606,73 @@ declare namespace Word { * Specifies the screen size for web page preview and HTML export optimization. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ScreenSize { /** * Screen resolution 544x376 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size544x376 = "Size544x376", /** * Screen resolution 640x480 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size640x480 = "Size640x480", /** * Screen resolution 720x512 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size720x512 = "Size720x512", /** * Screen resolution 800x600 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size800x600 = "Size800x600", /** * Screen resolution 1024x768 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size1024x768 = "Size1024x768", /** * Screen resolution 1152x882 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size1152x882 = "Size1152x882", /** * Screen resolution 1152x900 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size1152x900 = "Size1152x900", /** * Screen resolution 1280x1024 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size1280x1024 = "Size1280x1024", /** * Screen resolution 1600x1200 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size1600x1200 = "Size1600x1200", /** * Screen resolution 1800x1440 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size1800x1440 = "Size1800x1440", /** * Screen resolution 1920x1200 pixels. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ size1920x1200 = "Size1920x1200", } @@ -124430,50 +123680,43 @@ declare namespace Word { * Specifies the target web browser for HTML export and web page optimization. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum TargetBrowser { /** * Browser version 3. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ v3 = "V3", /** * Browser version 4. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ v4 = "V4", /** * Microsoft Internet Explorer 4. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ie4 = "Ie4", /** * Microsoft Internet Explorer 5. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ie5 = "Ie5", /** * Microsoft Internet Explorer 6. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ie6 = "Ie6", } /** * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class HtmlDivision extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -124483,56 +123726,49 @@ declare namespace Word { * Gets a `Range` object that represents the portion of a document that's contained in this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Specifies the left indent value (in points) for this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftIndent: number; /** * Specifies the right indent (in points) for this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightIndent: number; /** * Specifies the amount of spacing (in points) after this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaceAfter: number; /** * Specifies the spacing (in points) before this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaceBefore: number; /** * Deletes this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete(): void; /** * Returns an `HtmlDivision` object that represents a parent division of the current HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param levelsUp Optional. The number of levels to go up to retrieve the parent division. */ @@ -124576,8 +123812,7 @@ declare namespace Word { * Represents a collection of {@link Word.HtmlDivision} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class HtmlDivisionCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -124588,8 +123823,7 @@ declare namespace Word { * Returns an `HtmlDivision` object from the collection based on the specified index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param index The index of the item to retrieve. */ @@ -125516,8 +124750,7 @@ declare namespace Word { * Represents a dropped capital letter in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class DropCap extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -125526,48 +124759,42 @@ declare namespace Word { * Gets the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly distanceFromText: number; /** * Gets the name of the font for the dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly fontName: string; /** * Gets the height (in lines) of the dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly linesToDrop: number; /** * Gets the position of the dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; /** * Removes the dropped capital letter formatting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ clear(): void; /** * Formats the first character in the specified paragraph as a dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enable(): void; /** @@ -126664,7 +125891,7 @@ declare namespace Word { after = "After", } /** - * Represents the location of a {@link Word.Border | border}. + * Represents the location of a {@link https://learn.microsoft.com/javascript/api/word/word.border | border}. * * @remarks * [Api set: WordApi 1.3] @@ -126832,7 +126059,7 @@ declare namespace Word { mixed = "Mixed", } /** - * The {@link Word.Border | border} types. + * The {@link https://learn.microsoft.com/javascript/api/word/word.border | border} types. * * @remarks * [Api set: WordApi 1.3] @@ -127015,50 +126242,6 @@ declare namespace Word { */ bottom = "Bottom", } - /** - * Represents the type of baseline alignment. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum BaselineAlignment { - /** - * Represents top baseline alignment. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - top = "Top", - /** - * Represents center baseline alignment. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - center = "Center", - /** - * Represents baseline alignment. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - baseline = "Baseline", - /** - * Represents Far East 50% baseline alignment. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - farEast50 = "FarEast50", - /** - * Represents automatic baseline alignment. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - auto = "Auto", - } /** * Represents the type of list level. * @@ -128113,71 +127296,61 @@ declare namespace Word { * Specifies the type of item to print from a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum PrintOutItem { /** * Represents printing the document content. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentContent = "DocumentContent", /** * Represents printing the document properties. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ properties = "Properties", /** * Represents printing the comments. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ comments = "Comments", /** * Represents printing the markup. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ markup = "Markup", /** * Represents printing the styles. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ styles = "Styles", /** * Represents printing the AutoText entries. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ autoTextEntries = "AutoTextEntries", /** * Represents printing the key assignments. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ keyAssignments = "KeyAssignments", /** * Represents printing the envelope. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ envelope = "Envelope", /** * Represents printing the document with markup. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentWithMarkup = "DocumentWithMarkup", } @@ -128185,29 +127358,25 @@ declare namespace Word { * Specifies which pages to print based on odd or even page numbers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum PrintOutPages { /** * Represents printing all pages. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ all = "All", /** * Represents printing only odd-numbered pages. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oddOnly = "OddOnly", /** * Represents printing only even-numbered pages. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ evenOnly = "EvenOnly", } @@ -128215,43 +127384,37 @@ declare namespace Word { * Specifies the range of content to print from a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum PrintOutRange { /** * Represents printing the entire document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ allDocument = "AllDocument", /** * Represents printing the current selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selection = "Selection", /** * Represents printing the current page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ currentPage = "CurrentPage", /** * Represents printing a range from one page to another. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fromTo = "FromTo", /** * Represents printing specific ranges of pages. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rangeOfPages = "RangeOfPages", } @@ -128259,22 +127422,19 @@ declare namespace Word { * Specifies the export format for a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ExportFormat { /** * PDF export format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pdf = "Pdf", /** * XPS export format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xps = "Xps", } @@ -128282,22 +127442,19 @@ declare namespace Word { * Specifies the export item type for a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ExportItem { /** * Exports document content only. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentContent = "DocumentContent", /** * Exports document with markup (annotations). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentWithMarkup = "DocumentWithMarkup", } @@ -128305,22 +127462,19 @@ declare namespace Word { * Specifies the optimization target for document export. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ExportOptimizeFor { /** * Optimizes for print. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ print = "Print", /** * Optimizes for on-screen display. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ onScreen = "OnScreen", } @@ -128328,36 +127482,31 @@ declare namespace Word { * Specifies the range to export from a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ExportRange { /** * Exports the entire document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ allDocument = "AllDocument", /** * Exports the current selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selection = "Selection", /** * Exports the current page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ currentPage = "CurrentPage", /** * Exports a specific range of pages. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fromTo = "FromTo", } @@ -128365,29 +127514,25 @@ declare namespace Word { * Specifies the type of bookmarks to create during export. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ExportCreateBookmarks { /** * Do not create bookmarks. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Creates bookmarks from headings. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ headings = "Headings", /** * Creates bookmarks from Word bookmarks. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ wordBookmarks = "WordBookmarks", } @@ -128395,29 +127540,25 @@ declare namespace Word { * Specifies the source of formatting to use during document operations. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum UseFormattingFrom { /** * Represents using formatting from the current document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ current = "Current", /** * Represents using formatting from the selected document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selected = "Selected", /** * Represents prompting the user for formatting preferences. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ prompt = "Prompt", } @@ -128425,50 +127566,43 @@ declare namespace Word { * Indicates the auto macros that can run automatically in Word. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum AutoMacro { /** * Indicates that the macro runs automatically when Word starts. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ startWord = "StartWord", /** * Indicates that the macro runs automatically when a new document is created. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ new = "New", /** * Indicates that the macro runs automatically when the document is opened. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ open = "Open", /** * Indicates that the macro runs automatically when the document is closed. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ close = "Close", /** * Indicates that the macro runs automatically when the document is saved. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ exit = "Exit", /** * Indicates that the macro runs automatically when the document is synchronized. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sync = "Sync", } @@ -128476,57 +127610,49 @@ declare namespace Word { * Document statistic types. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - enum Statistic { + enum StatisticType { /** * Words in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ words = "Words", /** * Lines in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lines = "Lines", /** * Pages in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pages = "Pages", /** * Characters in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ characters = "Characters", /** * Paragraphs in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ paragraphs = "Paragraphs", /** * Characters including spaces. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ charactersWithSpaces = "CharactersWithSpaces", /** * Far East (DBCS) characters. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ farEastCharacters = "FarEastCharacters", } @@ -128534,148 +127660,127 @@ declare namespace Word { * Specifies the type of document information to remove. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum RemoveDocInfoType { /** * Comments in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ comments = "Comments", /** * Revisions in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisions = "Revisions", /** * Versions in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ versions = "Versions", /** * Personal information in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ removePersonalInformation = "RemovePersonalInformation", /** * Email header in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ emailHeader = "EmailHeader", /** * Routing slip in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ routingSlip = "RoutingSlip", /** * Send for review information in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sendForReview = "SendForReview", /** * Document properties. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentProperties = "DocumentProperties", /** * Template information. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ template = "Template", /** * Document workspace properties. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentWorkspace = "DocumentWorkspace", /** * Ink annotations in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ inkAnnotations = "InkAnnotations", /** * Document server properties. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentServerProperties = "DocumentServerProperties", /** * Document management policy. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentManagementPolicy = "DocumentManagementPolicy", /** * Content type information. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ contentType = "ContentType", /** * Taskpane web extensions. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ taskpaneWebExtensions = "TaskpaneWebExtensions", /** * At mentions in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ atMentions = "AtMentions", /** * Document tasks. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentTasks = "DocumentTasks", /** * Document intelligence information. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentIntelligence = "DocumentIntelligence", /** * Comment reactions in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ commentReactions = "CommentReactions", /** * All document information types. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ all = "All", } @@ -128683,29 +127788,25 @@ declare namespace Word { * Specifies the version type for document check-in operations. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum CheckInVersionType { /** * Represents a minor version check-in. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ minor = "Minor", /** * Represents a major version check-in. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ major = "Major", /** * Represents an overwrite version check-in. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ overwrite = "Overwrite", } @@ -128713,29 +127814,25 @@ declare namespace Word { * Specifies the target document for merge operations. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum MergeTarget { /** * Represents merging into the selected document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selected = "Selected", /** * Represents merging into the current document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ current = "Current", /** * Represents merging into a new document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ new = "New", } @@ -128845,7 +127942,7 @@ declare namespace Word { ignoreUppercase?: boolean; } /** - * Provides configuration options for the {@link Word.Document | Document.range} method. + * Provides configuration options for the {@link Word.Document | Document.getRange} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -129832,29 +128929,25 @@ declare namespace Word { * Specifies the type of document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum DocumentType { /** * Represents a standard document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ document = "Document", /** * Represents a document template. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ template = "Template", /** * Represents a frameset document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ frameset = "Frameset", } @@ -129862,29 +128955,25 @@ declare namespace Word { * Specifies the kind or purpose of a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum DocumentKind { /** * Represents a document with no specified kind. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ notSpecified = "NotSpecified", /** * Represents a letter document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ letter = "Letter", /** * Represents an email document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ email = "Email", } @@ -129892,183 +128981,157 @@ declare namespace Word { * Represents the file format to use when saving a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum FileSaveFormat { /** * Represents Microsoft Office Word 97 - 2003 binary file format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ document = "Document", /** * Represents Word template format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ template = "Template", /** * Represents Microsoft Windows text format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ text = "Text", /** * Represents Windows text format with line breaks preserved. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ textLineBreaks = "TextLineBreaks", /** * Represents Microsoft DOS text format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ dosText = "DosText", /** * Represents Microsoft DOS text with line breaks preserved. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ dosTextLineBreaks = "DosTextLineBreaks", /** * Represents Rich Text Format (RTF). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rtf = "Rtf", /** * Represents Unicode text format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unicodeText = "UnicodeText", /** * Represents standard HTML format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ html = "Html", /** * Represents Web archive format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ webArchive = "WebArchive", /** * Represents filtered HTML format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ filteredHtml = "FilteredHtml", /** * Represents Extensible Markup Language (XML) format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xml = "Xml", /** * Represents XML document format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlDocument = "XmlDocument", /** * Represents XML document format with macros enabled. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlDocumentMacroEnabled = "XmlDocumentMacroEnabled", /** * Represents XML template format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlTemplate = "XmlTemplate", /** * Represents XML template format with macros enabled. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlTemplateMacroEnabled = "XmlTemplateMacroEnabled", /** * Represents Word default document file format. For Word, this is the DOCX format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ documentDefault = "DocumentDefault", /** * Represents PDF format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pdf = "Pdf", /** * Represents XPS format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xps = "Xps", /** * Represents Open XML file format saved as a single XML file. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ flatXml = "FlatXml", /** * Represents Open XML file format with macros enabled saved as a single XML file. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ flatXmlMacroEnabled = "FlatXmlMacroEnabled", /** * Represents Open XML template format saved as a single XML file. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ flatXmlTemplate = "FlatXmlTemplate", /** * Represents Open XML template format with macros enabled saved as a single XML file. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ flatXmlTemplateMacroEnabled = "FlatXmlTemplateMacroEnabled", /** * Represents OpenDocument Text format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ openDocumentText = "OpenDocumentText", /** * Represents Strict Open XML document format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ strictOpenXmlDocument = "StrictOpenXmlDocument", } @@ -130076,43 +129139,37 @@ declare namespace Word { * Specifies the protection type for a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ProtectionType { /** * No protection is applied to the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noProtection = "NoProtection", /** * Only revisions are allowed in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ allowOnlyRevisions = "AllowOnlyRevisions", /** * Only comments are allowed in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ allowOnlyComments = "AllowOnlyComments", /** * Only form fields are allowed in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ allowOnlyFormFields = "AllowOnlyFormFields", /** * Only reading is allowed in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ allowOnlyReading = "AllowOnlyReading", } @@ -130120,43 +129177,37 @@ declare namespace Word { * Represents how Word marks line and paragraph breaks in text files. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum LineEndingType { /** * Represents carriage return and line feed (Windows standard). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ crlf = "Crlf", /** * Represents carriage return only (Mac classic standard). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ crOnly = "CrOnly", /** * Represents line feed only (Unix/Linux standard). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lfOnly = "LfOnly", /** * Represents line feed and carriage return. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lfcr = "Lfcr", /** * Represents line separator and paragraph separator. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lsps = "Lsps", } @@ -130164,967 +129215,829 @@ declare namespace Word { * Specifies the document encoding types. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum DocumentEncoding { /** * Thai encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ thai = "Thai", /** * Japanese Shift Japanese Industrial Standards (Shift JIS) encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ japaneseShiftJis = "JapaneseShiftJis", /** * Simplified Chinese Guojia Biaozhun Kuozhan (GBK, which means "National Standard Extended" in Chinese) encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ simplifiedChineseGbk = "SimplifiedChineseGbk", /** * Korean encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ korean = "Korean", /** * Traditional Chinese Big5 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ traditionalChineseBig5 = "TraditionalChineseBig5", /** * Unicode Little Endian encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unicodeLittleEndian = "UnicodeLittleEndian", /** * Unicode Big Endian encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unicodeBigEndian = "UnicodeBigEndian", /** * Central European encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ centralEuropean = "CentralEuropean", /** * Cyrillic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cyrillic = "Cyrillic", /** * Western encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ western = "Western", /** * Greek encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ greek = "Greek", /** * Turkish encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ turkish = "Turkish", /** * Hebrew encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hebrew = "Hebrew", /** * Arabic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arabic = "Arabic", /** * Baltic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ baltic = "Baltic", /** * Vietnamese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ vietnamese = "Vietnamese", /** * Auto detect encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ autoDetect = "AutoDetect", /** * Japanese auto detect encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ japaneseAutoDetect = "JapaneseAutoDetect", /** * Simplified Chinese auto detect encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ simplifiedChineseAutoDetect = "SimplifiedChineseAutoDetect", /** * Korean auto detect encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ koreanAutoDetect = "KoreanAutoDetect", /** * Traditional Chinese auto detect encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ traditionalChineseAutoDetect = "TraditionalChineseAutoDetect", /** * Cyrillic auto detect encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cyrillicAutoDetect = "CyrillicAutoDetect", /** * Greek auto detect encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ greekAutoDetect = "GreekAutoDetect", /** * Arabic auto detect encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arabicAutoDetect = "ArabicAutoDetect", /** * ISO 8859-1 Latin1 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso88591Latin1 = "Iso88591Latin1", /** * ISO 8859-2 Central Europe encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso88592CentralEurope = "Iso88592CentralEurope", /** * ISO 8859-3 Latin3 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso88593Latin3 = "Iso88593Latin3", /** * ISO 8859-4 Baltic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso88594Baltic = "Iso88594Baltic", /** * ISO 8859-5 Cyrillic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso88595Cyrillic = "Iso88595Cyrillic", /** * ISO 8859-6 Arabic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso88596Arabic = "Iso88596Arabic", /** * ISO 8859-7 Greek encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso88597Greek = "Iso88597Greek", /** * ISO 8859-8 Hebrew encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso88598Hebrew = "Iso88598Hebrew", /** * ISO 8859-9 Turkish encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso88599Turkish = "Iso88599Turkish", /** * ISO 8859-15 Latin9 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso885915Latin9 = "Iso885915Latin9", /** * ISO 8859-8 Hebrew logical encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso88598HebrewLogical = "Iso88598HebrewLogical", /** * ISO 2022-JP no halfwidth katakana encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso2022JpNoHalfwidthKatakana = "Iso2022JpNoHalfwidthKatakana", /** * ISO 2022-JP JIS X 0202-1984 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso2022JpJisX02021984 = "Iso2022JpJisX02021984", /** * ISO 2022-JP JIS X 0201-1989 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso2022JpJisX02011989 = "Iso2022JpJisX02011989", /** * ISO 2022-KR encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso2022Kr = "Iso2022Kr", /** * ISO 2022-CN Traditional Chinese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso2022CnTraditionalChinese = "Iso2022CnTraditionalChinese", /** * ISO 2022-CN Simplified Chinese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso2022CnSimplifiedChinese = "Iso2022CnSimplifiedChinese", /** * Mac Roman encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macRoman = "MacRoman", /** * Mac Japanese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macJapanese = "MacJapanese", /** * Mac Traditional Chinese Big5 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macTraditionalChineseBig5 = "MacTraditionalChineseBig5", /** * Mac Korean encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macKorean = "MacKorean", /** * Mac Arabic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macArabic = "MacArabic", /** * Mac Hebrew encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macHebrew = "MacHebrew", /** * Mac Greek1 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macGreek1 = "MacGreek1", /** * Mac Cyrillic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macCyrillic = "MacCyrillic", /** * Mac Simplified Chinese GB2312 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macSimplifiedChineseGb2312 = "MacSimplifiedChineseGb2312", /** * Mac Romania encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macRomania = "MacRomania", /** * Mac Ukraine encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macUkraine = "MacUkraine", /** * Mac Latin2 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macLatin2 = "MacLatin2", /** * Mac Icelandic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macIcelandic = "MacIcelandic", /** * Mac Turkish encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macTurkish = "MacTurkish", /** * Mac Croatia encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ macCroatia = "MacCroatia", /** * EBCDIC US-Canada encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicUsCanada = "EbcdicUsCanada", /** * EBCDIC International encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicInternational = "EbcdicInternational", /** * EBCDIC Multilingual ROECE Latin2 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicMultilingualRoeceLatin2 = "EbcdicMultilingualRoeceLatin2", /** * EBCDIC Greek Modern encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicGreekModern = "EbcdicGreekModern", /** * EBCDIC Turkish Latin5 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicTurkishLatin5 = "EbcdicTurkishLatin5", /** * EBCDIC Germany encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicGermany = "EbcdicGermany", /** * EBCDIC Denmark-Norway encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicDenmarkNorway = "EbcdicDenmarkNorway", /** * EBCDIC Finland-Sweden encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicFinlandSweden = "EbcdicFinlandSweden", /** * EBCDIC Italy encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicItaly = "EbcdicItaly", /** * EBCDIC Latin America-Spain encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicLatinAmericaSpain = "EbcdicLatinAmericaSpain", /** * EBCDIC United Kingdom encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicUnitedKingdom = "EbcdicUnitedKingdom", /** * EBCDIC Japanese Katakana Extended encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicJapaneseKatakanaExtended = "EbcdicJapaneseKatakanaExtended", /** * EBCDIC France encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicFrance = "EbcdicFrance", /** * EBCDIC Arabic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicArabic = "EbcdicArabic", /** * EBCDIC Greek encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicGreek = "EbcdicGreek", /** * EBCDIC Hebrew encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicHebrew = "EbcdicHebrew", /** * EBCDIC Korean Extended encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicKoreanExtended = "EbcdicKoreanExtended", /** * EBCDIC Thai encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicThai = "EbcdicThai", /** * EBCDIC Icelandic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicIcelandic = "EbcdicIcelandic", /** * EBCDIC Turkish encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicTurkish = "EbcdicTurkish", /** * EBCDIC Russian encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicRussian = "EbcdicRussian", /** * EBCDIC Serbian-Bulgarian encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicSerbianBulgarian = "EbcdicSerbianBulgarian", /** * EBCDIC Japanese Katakana Extended and Japanese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicJapaneseKatakanaExtendedAndJapanese = "EbcdicJapaneseKatakanaExtendedAndJapanese", /** * EBCDIC US-Canada and Japanese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicUsCanadaAndJapanese = "EbcdicUsCanadaAndJapanese", /** * EBCDIC Korean Extended and Korean encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicKoreanExtendedAndKorean = "EbcdicKoreanExtendedAndKorean", /** * EBCDIC Simplified Chinese Extended and Simplified Chinese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicSimplifiedChineseExtendedAndSimplifiedChinese = "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese", /** * EBCDIC US-Canada and Traditional Chinese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicUsCanadaAndTraditionalChinese = "EbcdicUsCanadaAndTraditionalChinese", /** * EBCDIC Japanese Latin Extended and Japanese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ebcdicJapaneseLatinExtendedAndJapanese = "EbcdicJapaneseLatinExtendedAndJapanese", /** * OEM United States encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemUnitedStates = "OemUnitedStates", /** * OEM Greek 437G encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemGreek437G = "OemGreek437G", /** * OEM Baltic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemBaltic = "OemBaltic", /** * OEM Multilingual Latin I encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemMultilingualLatinI = "OemMultilingualLatinI", /** * OEM Multilingual Latin II encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemMultilingualLatinIi = "OemMultilingualLatinIi", /** * OEM Cyrillic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemCyrillic = "OemCyrillic", /** * OEM Turkish encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemTurkish = "OemTurkish", /** * OEM Portuguese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemPortuguese = "OemPortuguese", /** * OEM Icelandic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemIcelandic = "OemIcelandic", /** * OEM Hebrew encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemHebrew = "OemHebrew", /** * OEM Canadian French encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemCanadianFrench = "OemCanadianFrench", /** * OEM Arabic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemArabic = "OemArabic", /** * OEM Nordic encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemNordic = "OemNordic", /** * OEM Cyrillic II encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemCyrillicIi = "OemCyrillicIi", /** * OEM Modern Greek encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oemModernGreek = "OemModernGreek", /** * EUC Japanese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ eucJapanese = "EucJapanese", /** * EUC Chinese Simplified Chinese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ eucChineseSimplifiedChinese = "EucChineseSimplifiedChinese", /** * EUC Korean encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ eucKorean = "EucKorean", /** * EUC Taiwanese Traditional Chinese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ eucTaiwaneseTraditionalChinese = "EucTaiwaneseTraditionalChinese", /** * ISCII Devanagari encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isciiDevanagari = "IsciiDevanagari", /** * ISCII Bengali encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isciiBengali = "IsciiBengali", /** * ISCII Tamil encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isciiTamil = "IsciiTamil", /** * ISCII Telugu encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isciiTelugu = "IsciiTelugu", /** * ISCII Assamese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isciiAssamese = "IsciiAssamese", /** * ISCII Oriya encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isciiOriya = "IsciiOriya", /** * ISCII Kannada encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isciiKannada = "IsciiKannada", /** * ISCII Malayalam encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isciiMalayalam = "IsciiMalayalam", /** * ISCII Gujarati encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isciiGujarati = "IsciiGujarati", /** * ISCII Punjabi encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isciiPunjabi = "IsciiPunjabi", /** * Arabic ASMO encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arabicAsmo = "ArabicAsmo", /** * Arabic Transparent ASMO encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arabicTransparentAsmo = "ArabicTransparentAsmo", /** * Korean Johab encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ koreanJohab = "KoreanJohab", /** * Taiwan CNS encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ taiwanCns = "TaiwanCns", /** * Taiwan TCA encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ taiwanTca = "TaiwanTca", /** * Taiwan Eten encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ taiwanEten = "TaiwanEten", /** * Taiwan IBM5550 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ taiwanIbm5550 = "TaiwanIbm5550", /** * Taiwan TeleText encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ taiwanTeleText = "TaiwanTeleText", /** * Taiwan Wang encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ taiwanWang = "TaiwanWang", /** * IA5 IRV encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ia5Irv = "Ia5Irv", /** * IA5 German encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ia5German = "Ia5German", /** * IA5 Swedish encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ia5Swedish = "Ia5Swedish", /** * IA5 Norwegian encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ia5Norwegian = "Ia5Norwegian", /** * US ASCII encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ usaAscii = "UsaAscii", /** * T61 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ t61 = "T61", /** * ISO 6937 Non-Spacing Accent encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iso6937NonSpacingAccent = "Iso6937NonSpacingAccent", /** * KOI8-R encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ koi8R = "Koi8R", /** * Ext Alpha Lowercase encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ extAlphaLowercase = "ExtAlphaLowercase", /** * KOI8-U encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ koi8U = "Koi8U", /** * Europa3 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ europa3 = "Europa3", /** * HZ GB Simplified Chinese encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hzGbSimplifiedChinese = "HzGbSimplifiedChinese", /** * Simplified Chinese GB18030 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ simplifiedChineseGb18030 = "SimplifiedChineseGb18030", /** * UTF-7 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ utf7 = "Utf7", /** * UTF-8 encoding. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ utf8 = "Utf8", } @@ -131132,43 +130045,37 @@ declare namespace Word { * Specifies the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum CompatibilityMode { /** * Word 2003 compatibility mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ word2003 = "Word2003", /** * Word 2007 compatibility mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ word2007 = "Word2007", /** * Word 2010 compatibility mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ word2010 = "Word2010", /** * Word 2013 compatibility mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ word2013 = "Word2013", /** * Current Word version compatibility mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ current = "Current", } @@ -132822,7 +131729,7 @@ declare namespace Word { outsideMargin = "OutsideMargin", } /** - * Specifies the shape type for a {@link Word.GeometricShape} object. + * Specifies the shape type for a {@link Word.ShapeType | ShapeType.geometricShape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -135447,29 +134354,6 @@ declare namespace Word { */ points = "Points", } - /** - * Represents the reading order of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReadingOrder { - /** - * Represents right-to-left reading order. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - rightToLeft = "RightToLeft", - /** - * Represents left-to-right reading order. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - leftToRight = "LeftToRight", - } /** * Specifies the way Word adjusts the table when the left indent is changed. * @@ -137172,71 +136056,61 @@ declare namespace Word { * Specifies the type of link. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum LinkType { /** * OLE object. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ole = "Ole", /** * Picture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ picture = "Picture", /** * Text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ text = "Text", /** * Reference library. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ reference = "Reference", /** * Include file. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ include = "Include", /** * Import file. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ import = "Import", /** * Dynamic Data Exchange. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ dde = "Dde", /** * Automatic DDE. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ddeAuto = "DdeAuto", /** * Microsoft Excel chart. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ chart = "Chart", } @@ -137244,57 +136118,49 @@ declare namespace Word { * Specifies the action associated with the verb that the OLE object should perform. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum OleVerb { /** * Performs the verb that is invoked when the user double-clicks the object. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ primary = "Primary", /** * Shows the object to the user for editing or viewing. Use it to show a newly inserted object for initial editing. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ show = "Show", /** * Opens the object in a separate window. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ open = "Open", /** * Removes the object's user interface from view. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hide = "Hide", /** * Activates the object in place and displays any user-interface tools that the object needs, such as menus or toolbars. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ uiActivate = "UiActivate", /** * Runs the object and installs its window, but doesn't install any user-interface tools. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ inPlaceActivate = "InPlaceActivate", /** * Forces the object to discard any undo state that it might be maintaining; note that the object remains active, however. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ discardUndoState = "DiscardUndoState", } @@ -143036,85 +141902,73 @@ declare namespace Word { * Specifies the seek view options in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum SeekView { /** * Main document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ mainDocument = "MainDocument", /** * Primary header. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ primaryHeader = "PrimaryHeader", /** * First page header. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ firstPageHeader = "FirstPageHeader", /** * Even pages header. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ evenPagesHeader = "EvenPagesHeader", /** * Primary footer. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ primaryFooter = "PrimaryFooter", /** * First page footer. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ firstPageFooter = "FirstPageFooter", /** * Even pages footer. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ evenPagesFooter = "EvenPagesFooter", /** * Footnotes. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnotes = "Footnotes", /** * Endnotes. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnotes = "Endnotes", /** * Current page header. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ currentPageHeader = "CurrentPageHeader", /** * Current page footer. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ currentPageFooter = "CurrentPageFooter", } @@ -143122,36 +141976,31 @@ declare namespace Word { * Specifies the source documents to show. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ShowSourceDocuments { /** * Specifies that no source documents are shown. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Specifies that the original source document is shown. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ original = "Original", /** * Specifies that the revised source document is shown. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revised = "Revised", /** * Specifies that both the original and revised source documents are shown. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ both = "Both", } @@ -143159,155 +142008,133 @@ declare namespace Word { * Specifies the special pane options in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum SpecialPane { /** * None. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Primary header. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ primaryHeader = "PrimaryHeader", /** * First page header. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ firstPageHeader = "FirstPageHeader", /** * Even pages header. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ evenPagesHeader = "EvenPagesHeader", /** * Primary footer. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ primaryFooter = "PrimaryFooter", /** * First page footer. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ firstPageFooter = "FirstPageFooter", /** * Even pages footer. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ evenPagesFooter = "EvenPagesFooter", /** * Footnotes. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnotes = "Footnotes", /** * Endnotes. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnotes = "Endnotes", /** * Footnote continuation notice. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnoteContinuationNotice = "FootnoteContinuationNotice", /** * Footnote continuation separator. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnoteContinuationSeparator = "FootnoteContinuationSeparator", /** * Footnote separator. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnoteSeparator = "FootnoteSeparator", /** * Endnote continuation notice. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnoteContinuationNotice = "EndnoteContinuationNotice", /** * Endnote continuation separator. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnoteContinuationSeparator = "EndnoteContinuationSeparator", /** * Endnote separator. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnoteSeparator = "EndnoteSeparator", /** * Comments. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ comments = "Comments", /** * Current page header. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ currentPageHeader = "CurrentPageHeader", /** * Current page footer. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ currentPageFooter = "CurrentPageFooter", /** * Revisions. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisions = "Revisions", /** * Revisions horizontal. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsHoriz = "RevisionsHoriz", /** * Revisions vertical. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsVert = "RevisionsVert", } @@ -143315,29 +142142,25 @@ declare namespace Word { * Specifies the save options. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum SaveConfiguration { /** * Specifies not to save changes. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ doNotSaveChanges = "DoNotSaveChanges", /** * Specifies to save changes. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ saveChanges = "SaveChanges", /** * Specifies to prompt to save changes. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ promptToSaveChanges = "PromptToSaveChanges", } @@ -143345,29 +142168,25 @@ declare namespace Word { * Specifies the page color options in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum PageColor { /** * None. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Sepia. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sepia = "Sepia", /** * Inverse. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ inverse = "Inverse", } @@ -143375,22 +142194,19 @@ declare namespace Word { * Specifies the page movement type in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum PageMovementType { /** * Vertical. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ vertical = "Vertical", /** * Side to side. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sideToSide = "SideToSide", } @@ -143398,29 +142214,25 @@ declare namespace Word { * Specifies the margin options in reading layout view in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ReadingLayoutMargin { /** * Microsoft Word determines automatically whether to show or hide the margins based on the available space. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ automatic = "Automatic", /** * Hides margins. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ suppress = "Suppress", /** * Shows margins. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ full = "Full", } @@ -143428,22 +142240,19 @@ declare namespace Word { * Specifies the margin for revision balloons in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum RevisionsBalloonMargin { /** * Left margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ left = "Left", /** * Right margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ right = "Right", } @@ -143451,22 +142260,19 @@ declare namespace Word { * Specifies the width type for revision balloons in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum RevisionsBalloonWidthType { /** * Balloon width as a percentage. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ percent = "Percent", /** * Balloon width in points. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ points = "Points", } @@ -143474,29 +142280,25 @@ declare namespace Word { * Specifies the extent of markup visible in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum RevisionsMarkup { /** * No markup. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Simple markup. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ simple = "Simple", /** * All markup. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ all = "All", } @@ -143504,29 +142306,25 @@ declare namespace Word { * Specifies the display mode for tracked changes in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum RevisionsMode { /** * Balloon. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ balloon = "Balloon", /** * Inline. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ inline = "Inline", /** * Mixed. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ mixed = "Mixed", } @@ -143534,22 +142332,19 @@ declare namespace Word { * Specifies whether Word displays the original version of a document or a version with revisions and formatting changes applied. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum RevisionsView { /** * Final view. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ final = "Final", /** * Original view. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ original = "Original", } @@ -143557,162 +142352,139 @@ declare namespace Word { * Specifies the revision type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum RevisionType { /** * No revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Insert revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ insert = "Insert", /** * Delete revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete = "Delete", /** * Property revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ property = "Property", /** * Paragraph number revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ paragraphNumber = "ParagraphNumber", /** * Display field revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ displayField = "DisplayField", /** * Reconcile revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ reconcile = "Reconcile", /** * Conflict revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ conflict = "Conflict", /** * Style revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ style = "Style", /** * Replace revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ replace = "Replace", /** * Paragraph property revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ paragraphProperty = "ParagraphProperty", /** * Table property revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableProperty = "TableProperty", /** * Section property revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sectionProperty = "SectionProperty", /** * Style definition revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ styleDefinition = "StyleDefinition", /** * Moved from revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ movedFrom = "MovedFrom", /** * Moved to revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ movedTo = "MovedTo", /** * Cell insertion revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cellInsertion = "CellInsertion", /** * Cell deletion revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cellDeletion = "CellDeletion", /** * Cell merge revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cellMerge = "CellMerge", /** * Cell split revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cellSplit = "CellSplit", /** * Conflict insert revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ conflictInsert = "ConflictInsert", /** * Conflict delete revision. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ conflictDelete = "ConflictDelete", } @@ -143720,29 +142492,25 @@ declare namespace Word { * Specifies the column width options in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ColumnWidth { /** * Narrow column width. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ narrow = "Narrow", /** * Default column width. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ default = "Default", /** * Wide column width. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ wide = "Wide", } @@ -143750,29 +142518,25 @@ declare namespace Word { * Specifies the field shading options in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum FieldShading { /** * Never shade fields. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ never = "Never", /** * Always shade fields. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ always = "Always", /** * Shade fields when selected. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ whenSelected = "WhenSelected", } @@ -143780,29 +142544,25 @@ declare namespace Word { * Specifies the format for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum HorizontalInVerticalType { /** * No formatting is applied to the horizontal text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * The horizontal text is sized to fit in the line of vertical text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitInLine = "FitInLine", /** * The line of vertical text is sized to accommodate the horizontal text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ resizeLine = "ResizeLine", } @@ -143810,78 +142570,67 @@ declare namespace Word { * Specifies the IME (Input Method Editor) mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ImeMode { /** * Specifies no control over the IME mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noControl = "NoControl", /** * Specifies the IME mode is on. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ on = "On", /** * Specifies the IME mode is off. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ off = "Off", /** * Specifies the Hiragana IME mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hiragana = "Hiragana", /** * Specifies the Katakana (double-byte) IME mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ katakana = "Katakana", /** * Specifies the Katakana (half-width) IME mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ katakanaHalf = "KatakanaHalf", /** * Specifies the full-width alphanumeric IME mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ alphaFull = "AlphaFull", /** * Specifies the half-width alphanumeric IME mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ alpha = "Alpha", /** * Specifies the full-width Hangul IME mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hangulFull = "HangulFull", /** * Specifies the half-width Hangul IME mode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hangul = "Hangul", } @@ -143889,22 +142638,19 @@ declare namespace Word { * Specifies the Kana type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum Kana { /** * Katakana Kana type. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ katakana = "Katakana", /** * Hiragana Kana type. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hiragana = "Hiragana", } @@ -143912,349 +142658,191 @@ declare namespace Word { * Specifies the two lines in one type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum TwoLinesInOneType { /** * No two lines in one. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Two lines in one without brackets. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noBrackets = "NoBrackets", /** * Two lines in one with parentheses. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ parentheses = "Parentheses", /** * Two lines in one with square brackets. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ squareBrackets = "SquareBrackets", /** * Two lines in one with angle brackets. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ angleBrackets = "AngleBrackets", /** * Two lines in one with curly brackets. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ curlyBrackets = "CurlyBrackets", } /** - * Specifies the underline type. + * Specifies the view type in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - enum Underline { + enum ViewType { /** - * No underline. + * Normal. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - none = "None", + normal = "Normal", /** - * Single underline. + * Outline. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - single = "Single", + outline = "Outline", /** - * Underline words only. + * Print. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - words = "Words", + print = "Print", /** - * Double underline. + * Print preview. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - double = "Double", + printPreview = "PrintPreview", /** - * Dotted underline. + * Master. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - dotted = "Dotted", + master = "Master", /** - * Thick underline. + * Web. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - thick = "Thick", + web = "Web", /** - * Dash underline. + * Reading. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - dash = "Dash", + reading = "Reading", /** - * Dot dash underline. + * Conflict. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - dotDash = "DotDash", + conflict = "Conflict", + } + /** + * Represents the state of the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum WindowState { /** - * Dot dot dash underline. + * Represents the normal state of the window. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - dotDotDash = "DotDotDash", + normal = "Normal", /** - * Wavy underline. + * Represents the maximized state of the window. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - wavy = "Wavy", + maximize = "Maximize", /** - * Heavy wavy underline. + * Represents the minimized state of the window. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - wavyHeavy = "WavyHeavy", + minimize = "Minimize", + } + /** + * Specifies the type of the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum WindowType { /** - * Heavy dotted underline. + * Specifies a document window. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - dottedHeavy = "DottedHeavy", + document = "Document", /** - * Heavy dash underline. + * Specifies a template window. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - dashHeavy = "DashHeavy", + template = "Template", + } + /** + * Represents the options for the {@link Word.Selection | Selection.convertToTable} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionConvertToTableOptions { /** - * Heavy dot dash underline. + * If provided, specifies whether to apply borders to the table of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDashHeavy = "DotDashHeavy", + applyBorders?: boolean; /** - * Heavy dot dot dash underline. + * If provided, specifies whether to apply color formatting to the table of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDotDashHeavy = "DotDotDashHeavy", + applyColor?: boolean; /** - * Long dash underline. + * If provided, specifies whether to apply special formatting to the first column of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLong = "DashLong", + applyFirstColumn?: boolean; /** - * Heavy long dash underline. + * If provided, specifies whether to apply font formatting to the table of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLongHeavy = "DashLongHeavy", + applyFont?: boolean; /** - * Double wavy underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - wavyDouble = "WavyDouble", - } - /** - * Specifies the view type in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ViewType { - /** - * Normal. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - normal = "Normal", - /** - * Outline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - outline = "Outline", - /** - * Print. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - print = "Print", - /** - * Print preview. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - printPreview = "PrintPreview", - /** - * Master. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - master = "Master", - /** - * Web. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - web = "Web", - /** - * Reading. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - reading = "Reading", - /** - * Conflict. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - conflict = "Conflict", - } - /** - * Represents the state of the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum WindowState { - /** - * Represents the normal state of the window. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - normal = "Normal", - /** - * Represents the maximized state of the window. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - maximize = "Maximize", - /** - * Represents the minimized state of the window. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - minimize = "Minimize", - } - /** - * Specifies the type of the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum WindowType { - /** - * Specifies a document window. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - document = "Document", - /** - * Specifies a template window. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - template = "Template", - } - /** - * Represents the options for the {@link Word.Selection | Selection.convertToTable} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface SelectionConvertToTableOptions { - /** - * If provided, specifies whether to apply borders to the table of the specified format. Default value is `true`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - applyBorders?: boolean; - /** - * If provided, specifies whether to apply color formatting to the table of the specified format. Default value is `true`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - applyColor?: boolean; - /** - * If provided, specifies whether to apply special formatting to the first column of the specified format. Default value is `true`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - applyFirstColumn?: boolean; - /** - * If provided, specifies whether to apply font formatting to the table of the specified format. Default value is `true`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - applyFont?: boolean; - /** - * If provided, specifies whether to format the first row as a header row of the specified format. Default value is `true`. - * + * If provided, specifies whether to format the first row as a header row of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta @@ -144315,7 +142903,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format?: Word.TableFormat | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; + format?: Word.TableFormatType | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; /** * If provided, specifies the initial width of each column in the table, in points. If omitted, Word calculates and adjusts the column width so that the table stretches from margin to margin. * @@ -144353,155 +142941,64 @@ declare namespace Word { * Represents the options for the {@link Word.Selection | Selection.delete} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectionDeleteOptions { /** * If provided, specifies the number of units to be deleted. To delete units after the selection, collapse the selection and use a positive number. To delete units before the selection, collapse the selection and use a negative number. The default value is 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ count?: number; /** * If provided, specifies the unit by which the collapsed selection is to be deleted. The default value is `character`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } - /** - * Represents the options for the {@link Word.Selection | Selection.goTo} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface SelectionGoToOptions { - /** - * If provided, specifies the number of the item in the document. Only positive values are valid. The default value is 1. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - count?: number; - /** - * If provided, specifies the direction the range or selection is moved to. The default value is `next`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous"; - /** - * If provided, specifies the kind of item the range or selection is moved to. The default value is `page`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"; - /** - * If provided, specifies the name if the `item` property is set to {@link Word.GoToItem} type `bookmark`, `comment`, `field`, or `object`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - name?: string; - } - /** - * Represents the options for the {@link Word.Selection | Selection.insertCrossReference} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface SelectionInsertCrossReferenceOptions { - /** - * If provided, specifies whether to include position. `true` to insert "above" or "below," depending on the location of the reference item in relation to the cross-reference. The default value is `false`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - includePosition?: boolean; - /** - * If provided, specifies whether to insert the cross-reference as a hyperlink. The default value is `false`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - insertAsHyperlink?: boolean; - /** - * If provided, specifies whether to use a separator to separate the numbers from the associated text. The default value is `false`. (Use only if the `referenceType` parameter is set to `numberedItem` and the `referenceKind` parameter is set to `numberFullContext` when the `Selection.insertCrossReference` method is called.) - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - separateNumbers?: boolean; - /** - * If provided, specifies the string to use as a separator if the `separateNumbers` parameter is set to `true` when the `Selection.insertCrossReference` method is called. The default value is " ". - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - separatorString?: string; - } /** * Represents the options for the {@link Word.Selection | Selection.insertDateTime} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectionInsertDateTimeOptions { /** * If provided, specifies the calendar type to use when displaying the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ calendarType?: Word.CalendarTypeBidirectional | "Gregorian" | "Bidirectional"; /** * If provided, specifies the language in which to display the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ dateLanguage?: Word.DateLanguage | "Bidirectional" | "Latin"; /** * If provided, specifies the format to be used for displaying the date or time, or both. If this property is omitted, Microsoft Word uses the short-date style from the Windows Control Panel (Regional Settings icon). See {@link https://support.microsoft.com/office/47fbbdc1-52fa-416a-b8d5-ba24d881b698 | Date/Time data type} for format symbols. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ dateTimeFormat?: string; /** * If provided, specifies whether to insert the specified information as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ insertAsField?: boolean; /** * If provided, specifies whether to insert the specified information as full-width (double-byte) digits. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ insertAsFullWidth?: boolean; } @@ -144509,8 +143006,7 @@ declare namespace Word { * Represents the options for the {@link Word.Selection | Selection.insertFormula} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectionInsertFormulaOptions { /** @@ -144526,16 +143022,14 @@ declare namespace Word { - If you don't specify the `formula` property and all the cells above and to the left of the insertion point are empty, using the `= (Formula)` field causes an error. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formula?: string; /** * If provided, specifies the format for the result of the `= (Formula)` field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ numberFormat?: string; } @@ -144543,32 +143037,28 @@ declare namespace Word { * Represents the options for the {@link Word.Selection | Selection.insertSymbol} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectionInsertSymbolOptions { /** * If provided, specifies the font bias for symbols. This argument is useful for setting the correct font bias for East Asian characters. The default value is `default`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bias?: Word.FontBias | "Standard" | "FarEast" | "NoSpecified"; /** * If provided, specifies the name of the font that contains the symbol. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ font?: string; /** * If provided, specifies whether the character is Unicode. `true` to insert the Unicode character specified by the `characterNumber` property when the `Selection.insertSymbol` method is called; `false` to instead insert the ANSI character specified by the `characterNumber` property. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unicode?: boolean; } @@ -144576,32 +143066,28 @@ declare namespace Word { * Represents the options for the {@link Word.Selection | Selection.moveLeft and Selection.moveRight} methods. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectionMoveLeftRightOptions { /** * If provided, specifies the number of units the selection is to be moved. The default value is 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ count?: number; /** * If provided, specifies the type of movement. The movement direction (left or right) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ extend?: Word.MovementType | "Move" | "Extend"; /** * If provided, specifies the unit by which the selection is to be moved. The default value is `character`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } @@ -144609,24 +143095,21 @@ declare namespace Word { * Represents the options for the {@link Word.Selection | Selection.move} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectionMoveOptions { /** * If provided, specifies the number of units by which the range or selection is to be moved. If `count` is a positive number, the object is collapsed to its end position and moved backward in the document by the specified number of units. If `count` is a negative number, the object is collapsed to its start position and moved forward by the specified number of units. The default value is 1. You can also control the collapse direction by using the {@link Word.Selection | Selection.collapse} method before using the `move` method. If the range or selection is in the middle of a unit or isn't collapsed, moving it to the beginning or end of the unit counts as moving it one full unit. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ count?: number; /** * If provided, specifies the unit by which to move the ending character position. The default value is `character`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } @@ -144634,24 +143117,21 @@ declare namespace Word { * Represents the options for the {@link Word.Selection | Selection.moveEnd and Selection.moveStart} methods. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectionMoveStartEndOptions { /** * If provided, specifies the number of units to move. The affected character position (start or end) is according to the calling method. If this number is positive, the position is moved forward in the document. If this number is negative, the position is moved backward. If the affected position encounters the other position, the selection is collapsed and both the start and end positions move together. The default value is 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ count?: number; /** * If provided, specifies the unit by which the selection's start or end position (per the calling method) is to be moved. The default value is `character`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } @@ -144659,32 +143139,28 @@ declare namespace Word { * Represents the options for the {@link Word.Selection | Selection.moveUp and Selection.moveDown} methods. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectionMoveUpDownOptions { /** * If provided, specifies the number of units the selection is to be moved. The default value is 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ count?: number; /** * If provided, specifies the type of movement. The movement direction (up or down) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ extend?: Word.MovementType | "Move" | "Extend"; /** * If provided, specifies the unit by which to move the selection. The default value is `line`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } @@ -144692,24 +143168,21 @@ declare namespace Word { * Represents the options for the {@link Word.Selection | Selection.next} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectionNextOptions { /** * If provided, specifies the number of units by which you want to move ahead. The default value is 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ count?: number; /** * If provided, specifies the type of units by which to move the selection. The default value is `character`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } @@ -144717,24 +143190,21 @@ declare namespace Word { * Represents the options for the {@link Word.Selection | Selection.previous} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface SelectionPreviousOptions { /** * If provided, specifies the number of units by which you want to move. The default value is 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ count?: number; /** * If provided, specifies the type of unit by which to move the selection. The default value is `character`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } @@ -144742,10 +143212,9 @@ declare namespace Word { * Represents a selected range or the insertion point in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] + * [Api set: WordApiDesktop 1.4] * * Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. - * @beta */ class Selection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -144754,128 +143223,112 @@ declare namespace Word { * Returns a `BorderUniversalCollection` object that represents all the borders for the objects in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly borders: Word.BorderUniversalCollection; /** * Returns a `RangeScopedCollection` object that represents each character in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly characters: Word.RangeScopedCollection; /** * Returns a `CommentCollection` object that represents all the comments in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly comments: Word.CommentCollection; /** * Returns a `FieldCollection` object that represents all the fields in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly fields: Word.FieldCollection; /** * Returns the `Font` object that represents the character formatting of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly font: Word.Font; /** * Specifies a `Range` object that includes the formatted text in the range or selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formattedText: Word.Range; /** * Returns a `ParagraphCollection` object that represents all the paragraphs in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly paragraphs: Word.ParagraphCollection; /** * Returns the `Range` object for the portion of the document contained in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Returns the `SectionCollection` object in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly sections: Word.SectionCollection; /** * Returns the `RangeScopedCollection` object for each sentence in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly sentences: Word.RangeScopedCollection; /** * Returns the `ShadingUniversal` object for the shading formatting for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly shading: Word.ShadingUniversal; /** * Returns the `TableCollection` object in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly tables: Word.TableCollection; /** * Returns the tables at the outermost nesting level in the current selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly topLevelTables: Word.TableCollection; /** * Returns the `RangeScopedCollection` object that represents each word in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly words: Word.RangeScopedCollection; /** * Specifies the ending character position of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end: number; /** * Specifies the width in which Word fits the text in the current selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitTextWidth: number; /** @@ -144883,144 +143336,126 @@ declare namespace Word { If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly hasNoProofing: boolean; /** * Returns whether the selection in the specified window or pane is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isActive: boolean; /** * Specifies whether column selection mode is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isColumnSelectModeActive: boolean; /** * Returns whether the selection is at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isEndOfRowMark: boolean; /** * Specifies whether Extend mode is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isExtendModeActive: boolean; /** * Returns whether the insertion point is at the end of a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isInsertionPointAtEndOfLine: boolean; /** * Specifies whether the beginning of the selection is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isStartActive: boolean; /** * Specifies whether Word has detected the language of the selected text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageDetected: boolean; /** * Returns the language for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** * Returns the East Asian language for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** * Specifies the orientation of text in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** * Specifies the starting character position of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start: number; /** * Returns the number of characters in the story that contains the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly storyLength: number; /** * Returns the story type for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** * Specifies the text in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ text: string; /** * Returns the selection type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; /** * Calculates the first mathematical expression within the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * @returns The result of the calculation. */ calculate(): OfficeExtension.ClientResult; @@ -145028,64 +143463,56 @@ declare namespace Word { * Cancels a mode such as extend or column select. This is equivalent to pressing the Esc key. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cancelMode(): void; /** * Removes character formatting applied through character styles. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ clearCharacterStyleFormatting(): void; /** * Removes character and paragraph formatting from the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ clearFormatting(): void; /** * Removes manually applied character formatting from the selected text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ clearManualCharacterFormatting(): void; /** * Removes manually applied paragraph formatting from the selected text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ clearManualParagraphFormatting(): void; /** * Removes all paragraph formatting from the selected text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ clearParagraphFormatting(): void; /** * Removes paragraph formatting applied through paragraph styles. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ clearParagraphStyle(): void; /** * Collapses the selection to the starting or ending position. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param direction Optional. Direction to collapse. */ @@ -145094,8 +143521,7 @@ declare namespace Word { * Collapses the selection to the starting or ending position. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param direction Optional. Direction to collapse. */ @@ -145115,48 +143541,42 @@ declare namespace Word { * Copies the selection to the Clipboard as a picture. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ copyAsPictureToClipboard(): void; /** * Copies the character formatting of the first character in the selected text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ copyFormat(): void; /** * Copies the selection to the Clipboard. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ copyToClipboard(): void; /** * Adds a default-sized text box around the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ createTextBox(): void; /** * Removes the selected content from the document and moves it to the Clipboard. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cut(): void; /** * Deletes the specified number of characters or words. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for deleting text. * @returns The number of characters deleted. @@ -145166,16 +143586,14 @@ declare namespace Word { * Analyzes the selected text to determine the language that it's written in. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ detectLanguage(): void; /** * Expands the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param unit Optional. The unit to expand. * @returns The number of characters added to the range or selection. @@ -145185,8 +143603,7 @@ declare namespace Word { * Expands the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param unit Optional. The unit to expand. * @returns The number of characters added to the range or selection. @@ -145196,16 +143613,14 @@ declare namespace Word { * Expands the selection to include the entire story. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ expandToWholeStory(): void; /** * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param character Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. */ @@ -145214,8 +143629,7 @@ declare namespace Word { * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param character Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. */ @@ -145224,8 +143638,7 @@ declare namespace Word { * Returns a `Range` object that represents the next unit relative to the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for the `next` operation. * @returns A `Range` object that represents the next unit relative to the selection. @@ -145235,8 +143648,7 @@ declare namespace Word { * Returns a `Range` object that represents the previous unit relative to the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for the `previous` operation. * @returns A `Range` object that represents the previous unit relative to the selection. @@ -145252,13 +143664,12 @@ declare namespace Word { * @param options Optional. Options for the `goTo` operation. * @returns A `Range` object that is now selected. */ - goTo(options?: Word.SelectionGoToOptions): Word.Range; + goTo(options?: Word.GoToOptions): Word.Range; /** * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param what The item type to go to. * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. @@ -145268,8 +143679,7 @@ declare namespace Word { * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param what The item type to go to. * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. @@ -145279,8 +143689,7 @@ declare namespace Word { * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param what The item type to go to. * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. @@ -145290,8 +143699,7 @@ declare namespace Word { * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param what The item type to go to. * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. @@ -145301,8 +143709,7 @@ declare namespace Word { * Inserts the specified text at the end of the range or selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param text Text to insert. */ @@ -145311,8 +143718,7 @@ declare namespace Word { * Inserts the specified text before the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param text Text to insert. */ @@ -145321,8 +143727,7 @@ declare namespace Word { * Adds cells to an existing table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param shiftCells Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. */ @@ -145331,8 +143736,7 @@ declare namespace Word { * Adds cells to an existing table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param shiftCells Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. */ @@ -145341,24 +143745,21 @@ declare namespace Word { * Inserts columns to the left of the column that contains the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ insertColumnsLeft(): void; /** * Inserts columns to the right of the current selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ insertColumnsRight(): void; /** * Inserts the current date or time, or both, either as text or as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for inserting the date or time. */ @@ -145367,8 +143768,7 @@ declare namespace Word { * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Formula field} at the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for inserting the formula. */ @@ -145377,40 +143777,35 @@ declare namespace Word { * Inserts a new page at the position of the insertion point. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ insertNewPage(): void; /** * Inserts a paragraph mark after the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ insertParagraphAfter(): void; /** * Inserts a new paragraph before the selection or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ insertParagraphBefore(): void; /** * Inserts a special hidden paragraph mark that allows Word to join paragraphs formatted using different paragraph styles. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ insertParagraphStyleSeparator(): void; /** * Inserts rows above the current selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param numRows Optional. Number of rows to insert. */ @@ -145419,8 +143814,7 @@ declare namespace Word { * Inserts rows below the current selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param numRows Optional. Number of rows to insert. */ @@ -145429,8 +143823,7 @@ declare namespace Word { * Inserts a symbol in place of the specified selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param characterNumber The character number of the symbol. * @param options Optional. Options for inserting the symbol. @@ -145440,8 +143833,7 @@ declare namespace Word { * Inserts the specified text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param Text The text to insert. */ @@ -145450,8 +143842,7 @@ declare namespace Word { * Inserts the specified XML into the document at the cursor, replacing any selected text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param xml The XML string to insert. * @param transform Optional. XSL transform to apply. @@ -145461,8 +143852,7 @@ declare namespace Word { * Returns whether the selection is equal to the specified range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range to compare. * @returns `true` if the selection is equal to the specified range. @@ -145472,8 +143862,7 @@ declare namespace Word { * Returns `true` if the selection is contained within the specified range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range to compare. * @returns `true` if the selection is contained within the specified range. @@ -145483,8 +143872,7 @@ declare namespace Word { * Returns whether the selection is in the same story as the specified range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range to compare. * @returns `true` if the selection is in the same story as the specified range. @@ -145494,8 +143882,7 @@ declare namespace Word { * Collapses the selection to its start or end position and then moves the collapsed object by the specified number of units. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for moving the selection. * @returns The number of characters by which the selection was moved. @@ -145505,8 +143892,7 @@ declare namespace Word { * Moves the selection down. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for moving down. * @returns The number of characters by which the selection was moved. @@ -145516,8 +143902,7 @@ declare namespace Word { * Moves the ending character position of the range or selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for moving end. * @returns The number of characters by which the selection was moved. @@ -145527,8 +143912,7 @@ declare namespace Word { * Moves the end position of the selection until any of the specified characters are found in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param characters Characters to search for. For example. If you specify "a", the selection moves the end position to before the first "a" character. * @param count Optional. Maximum number of characters to search. @@ -145539,8 +143923,7 @@ declare namespace Word { * Moves the ending character position of the selection while any of the specified characters are found in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param characters Characters to search for. For example. If you specify "abcd", the selection moves the end position when any letter from "abcd" is found. * @param count Optional. Maximum number of characters to search. @@ -145551,8 +143934,7 @@ declare namespace Word { * Moves the selection to the left. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for moving left. * @returns The number of characters by which the selection was moved. @@ -145562,8 +143944,7 @@ declare namespace Word { * Moves the selection to the right. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for moving right. * @returns The number of characters by which the selection was moved. @@ -145573,8 +143954,7 @@ declare namespace Word { * Moves the start position of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for the `moveStart` operation. * @returns The number of characters by which the selection was moved. @@ -145584,8 +143964,7 @@ declare namespace Word { * Moves the start position of the selection until one of the specified characters is found in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param characters Characters to search for. If you specify "a", the selection moves the start position to before the first "a" character. * @param count Optional. Maximum number of characters to search. @@ -145596,8 +143975,7 @@ declare namespace Word { * Moves the start position of the selection while any of the specified characters are found in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param characters Characters to search for. For example. If you specify "abcd", the selection moves the start position when any letter from "abcd" is found. * @param count Optional. Maximum number of characters to search. @@ -145608,8 +143986,7 @@ declare namespace Word { * Moves the selection until one of the specified characters is found in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param characters Characters to search for. For example. If you specify "a", the selection moves to the position before the first "a" character. * @param count Optional. Maximum number of characters to search. @@ -145620,8 +143997,7 @@ declare namespace Word { * Moves the selection up. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param options Optional. Options for moving up. * @returns The number of characters by which the selection was moved. @@ -145631,8 +144007,7 @@ declare namespace Word { * Moves the selection while any of the specified characters are found in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param characters Characters to search for. For example. If you specify "abcd", the selection moves to the position when any letter from "abcd" is found. * @param count Optional. Maximum number of characters to search. @@ -145643,8 +144018,7 @@ declare namespace Word { * Selects the next field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * @returns The next field. */ nextField(): Word.Field; @@ -145652,16 +144026,14 @@ declare namespace Word { * Moves the selection to the next subdocument. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ nextSubdocument(): void; /** * Pastes the content from clipboard and formats them as specified. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param type The format paste type for table cells. */ @@ -145670,8 +144042,7 @@ declare namespace Word { * Pastes the content from clipboard and formats them as specified. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param type The format paste type for table cells. */ @@ -145680,8 +144051,7 @@ declare namespace Word { * Pastes and formats a Microsoft Excel table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param linkedToExcel Whether the table is linked to Excel. * @param wordFormatting Whether to apply Word formatting. @@ -145692,32 +144062,28 @@ declare namespace Word { * Applies formatting copied with the `copyFormat` method to the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pasteFormat(): void; /** * Merges pasted cells into an existing table by inserting the pasted rows between the selected rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pasteTableCellsAppendTable(): void; /** * Pastes a cell or group of cells as a nested table into the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pasteTableCellsAsNestedTable(): void; /** * Selects and returns the previous field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * @returns The previous field. */ previousField(): Word.Field; @@ -145725,96 +144091,84 @@ declare namespace Word { * Moves the selection to the previous subdocument. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previousSubdocument(): void; /** * Replaces the selection with a new paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ replaceParagraph(): void; /** * Selects the current text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ select(): void; /** * Selects the entire cell containing the current selection when the selection is in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectCell(): void; /** * Selects the column that contains the insertion point, or selects all columns that contain the selection when the selection is in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectColumn(): void; /** * Extends the selection forward until text with a different paragraph alignment is encountered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectCurrentAlignment(): void; /** * Extends the selection forward until text with a different color is encountered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectCurrentColor(): void; /** * Extends the selection forward until text in a different font or font size is encountered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectCurrentFont(): void; /** * Extends the selection forward until text with different left or right paragraph indents is encountered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectCurrentIndent(): void; /** * Extends the selection forward until a paragraph with different line spacing is encountered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectCurrentSpacing(): void; /** * Extends the selection forward until a paragraph with different tab stops is encountered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectCurrentTabs(): void; /** * Selects the row that contains the insertion point, or selects all rows that contain the selection when the selection is in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectRow(): void; /** @@ -145822,8 +144176,7 @@ declare namespace Word { Character position values start at the beginning of the story, with the first value being 0. All characters are counted, including nonprinting characters. Hidden characters are counted even if they're not displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param start The starting character position of the current story. * @param end The ending character position of the current story. @@ -145834,16 +144187,14 @@ declare namespace Word { The unit progression for this method is as follows: entire document, section, paragraph, sentence, word, insertion point. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shrink(): void; /** * Cancels the selection of all but the most recently selected text when the current selection contains multiple, unconnected selections. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shrinkDiscontiguousSelection(): void; /** @@ -145851,24 +144202,21 @@ declare namespace Word { If the selection isn't in the first row of the table, the table is split into two tables. If the selection isn't in a table, an error occurs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ splitTable(): void; /** * Switches the selection between a Unicode character and its corresponding hexadecimal value. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ toggleCharacterCode(): void; /** * Deletes the character preceding the selection (if collapsed) or the insertion point. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ typeBackspace(): void; /** @@ -145910,8 +144258,7 @@ declare namespace Word { * Represents a collection of {@link Word.Range} objects that represents each character, word, or sentence. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class RangeScopedCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -146458,29 +144805,25 @@ declare namespace Word { * Specifies how a table is resized to fit its contents or the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum AutoFitBehavior { /** * Disables automatic resizing. The table retains its current size. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fixedSize = "FixedSize", /** * Automatically resizes the table columns to fit the contents. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ content = "Content", /** * Automatically resizes the table to fit the window width. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ window = "Window", } @@ -146488,75 +144831,39 @@ declare namespace Word { * Specifies the type of bidirectional calendar to use. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum CalendarTypeBidirectional { /** * Uses the Gregorian calendar. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gregorian = "Gregorian", /** * Uses the Bidirectional calendar. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bidirectional = "Bidirectional", } - /** - * Specifies the type of caption label to use. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CaptionLabelType { - /** - * Specifies a figure caption label. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - figure = "Figure", - /** - * Specifies a table caption label. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - table = "Table", - /** - * Specifies an equation caption label. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - equation = "Equation", - } /** * Specifies the position of a caption relative to the object it describes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum CaptionPosition { /** * Places the caption above the selected item. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ above = "Above", /** * Places the caption below the selected item. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ below = "Below", } @@ -146564,22 +144871,19 @@ declare namespace Word { * Specifies the direction in which to collapse a selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum CollapseDirection { /** * Collapses the selection to the start position. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start = "Start", /** * Collapses the selection to the end position. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end = "End", } @@ -146587,22 +144891,19 @@ declare namespace Word { * Specifies the language to use for date formatting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum DateLanguage { /** * Uses the bidirectional date/time format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bidirectional = "Bidirectional", /** * Uses the latin date/time format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ latin = "Latin", } @@ -146629,116 +144930,61 @@ declare namespace Word { */ enableAutoFit = "EnableAutoFit", } - /** - * Specifies the location of endnotes in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum EndnoteLocation { - /** - * Places endnotes at the end of the section. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - endOfSection = "EndOfSection", - /** - * Places endnotes at the end of the document. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - endOfDocument = "EndOfDocument", - } /** * Specifies the font bias to use when formatting East Asian text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum FontBias { /** * Uses the default font bias. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ standard = "Standard", /** * Uses the font bias for Far East text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ farEast = "FarEast", /** * No font bias specified. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noSpecified = "NoSpecified", } - /** - * Specifies the location of footnotes in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FootnoteLocation { - /** - * Places footnotes at the bottom of the page. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - bottomOfPage = "BottomOfPage", - /** - * Places footnotes below the text on the page. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - beneathText = "BeneathText", - } /** * Specifies the direction in which to move when using the {@link Word.Selection | Selection.goTo} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum GoToDirection { /** * Moves to the first item. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ first = "First", /** * Moves to the last item. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ last = "Last", /** * Moves to the next item. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ next = "Next", /** * Moves to the previous item. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previous = "Previous", } @@ -146746,127 +144992,109 @@ declare namespace Word { * Specifies the item or location to which to move or extend a {@link Word.Selection | selection}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum GoToItem { /** * Moves to a bookmark. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bookmark = "Bookmark", /** * Moves to a comment. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ comment = "Comment", /** * Moves to a endnote. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnote = "Endnote", /** * Moves to a field. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ field = "Field", /** * Moves to a footnote. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnote = "Footnote", /** * Moves to a graphic. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ graphic = "Graphic", /** * Moves to a heading. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ heading = "Heading", /** * Moves to a line. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ line = "Line", /** * Moves to a page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ page = "Page", /** * Moves to a section. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ section = "Section", /** * Moves to a table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ table = "Table", /** * Moves to an embedded object. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ embeddedObject = "EmbeddedObject", /** * Moves to an equation. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ equation = "Equation", /** * Moves to a percent. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ percent = "Percent", /** * Moves to a spelling error. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spellingError = "SpellingError", /** * Moves to a grammatical error. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grammaticalError = "GrammaticalError", /** * Moves to a proofreading error. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ proofreadingError = "ProofreadingError", } @@ -146874,713 +145102,277 @@ declare namespace Word { * Specifies the type of movement when navigating through a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum MovementType { /** * Moves the insertion point or selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ move = "Move", /** * Extends the selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ extend = "Extend", } - /** - * Specifies the numbering style to use for footnotes or endnotes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NoteNumberStyle { - /** - * Uses Arabic numerals (1, 2, 3...). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - arabic = "Arabic", - /** - * Uses uppercase Roman numerals (I, II, III...). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - uppercaseRoman = "UppercaseRoman", - /** - * Uses lowercase Roman numerals (i, ii, iii...). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - lowercaseRoman = "LowercaseRoman", - /** - * Uses uppercase letters (A, B, C...). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - uppercaseLetter = "UppercaseLetter", - /** - * Uses lowercase letters (a, b, c...). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - lowercaseLetter = "LowercaseLetter", - /** - * Uses a symbol instead of a number. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - symbol = "Symbol", - /** - * Uses full-width Arabic numerals. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - arabicFullWidth = "ArabicFullWidth", - /** - * Uses Kanji characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - kanji = "Kanji", - /** - * Uses Kanji digits. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - kanjiDigit = "KanjiDigit", - /** - * Uses traditional Kanji characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - kanjiTraditional = "KanjiTraditional", - /** - * Uses numbers enclosed in circles. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - numberInCircle = "NumberInCircle", - /** - * Uses Hanja characters with phonetic reading. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hanjaRead = "HanjaRead", - /** - * Uses Hanja digits with phonetic reading. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hanjaReadDigit = "HanjaReadDigit", - /** - * Uses traditional Chinese numerals (style 1). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - traditionalChineseNumeral1 = "traditionalChineseNumeral1", - /** - * Uses traditional Chinese numerals (style 2). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - traditionalChineseNumeral2 = "traditionalChineseNumeral2", - /** - * Uses simplified Chinese numerals (style 1). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - simplifiedChineseNumeral1 = "simplifiedChineseNumeral1", - /** - * Uses simplified Chinese numerals (style 2). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - simplifiedChineseNumeral2 = "simplifiedChineseNumeral2", - /** - * Uses Hebrew letters (style 1). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hebrewLetter1 = "HebrewLetter1", - /** - * Uses Arabic letters (style 1). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - arabicLetter1 = "ArabicLetter1", - /** - * Uses Hebrew letters (style 2). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hebrewLetter2 = "HebrewLetter2", - /** - * Uses Arabic letters (style 2). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - arabicLetter2 = "ArabicLetter2", - /** - * Uses Hindi letters (style 1). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hindiLetter1 = "HindiLetter1", - /** - * Uses Hindi letters (style 2). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hindiLetter2 = "HindiLetter2", - /** - * Uses Hindi Arabic numerals. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hindiArabic = "HindiArabic", - /** - * Uses Hindi cardinal text. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hindiCardinalText = "HindiCardinalText", - /** - * Uses Thai letters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - thaiLetter = "ThaiLetter", - /** - * Uses Thai Arabic numerals. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - thaiArabic = "ThaiArabic", - /** - * Uses Thai cardinal text. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - thaiCardinalText = "ThaiCardinalText", - /** - * Uses Vietnamese cardinal text. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - vietnameseCardinalText = "vietnameseCardinalText", - } /** * Specifies the unit of measurement used in Word operations. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum OperationUnit { /** * Specifies a character unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ character = "Character", /** * Specifies a word unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ word = "Word", /** * Specifies a sentence unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sentence = "Sentence", /** * Specifies a paragraph unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ paragraph = "Paragraph", /** * Specifies a line unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ line = "Line", /** * Specifies a story unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ story = "Story", /** * Specifies a screen unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ screen = "Screen", /** * Specifies a section unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ section = "Section", /** * Specifies a column unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ column = "Column", /** * Specifies a row unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ row = "Row", /** * Specifies a window unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ window = "Window", /** * Specifies a cell unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ cell = "Cell", /** * Specifies a character format unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ characterFormat = "CharacterFormat", /** * Specifies a paragraph format unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ paragraphFormat = "ParagraphFormat", /** * Specifies a table unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ table = "Table", /** * Specifies an item unit. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ item = "Item", } - /** - * Specifies the format to use when pasting data. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PasteDataType { - /** - * Pastes the data as an OLE object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - oleObject = "OleObject", - /** - * Pastes the data as rich text format (RTF). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - rtf = "Rtf", - /** - * Pastes the data as plain text. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - text = "Text", - /** - * Pastes the data as a metafile picture. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - metafilePicture = "MetafilePicture", - /** - * Pastes the data as a bitmap. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - bitmap = "Bitmap", - /** - * Pastes the data as a device-independent bitmap (DIB). - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - deviceIndependentBitmap = "DeviceIndependentBitmap", - /** - * Pastes the data as a hyperlink. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hyperlink = "Hyperlink", - /** - * Pastes the data as a shape. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - shape = "Shape", - /** - * Pastes the data as an enhanced metafile. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enhancedMetafile = "EnhancedMetafile", - /** - * Pastes the data as HTML. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - html = "Html", - } /** * Specifies the type of formatting when paste to a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum PasteFormatType { /** * Uses the default paste behavior. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pasteDefault = "PasteDefault", /** * Pastes text into a single cell. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ singleCellText = "SingleCellText", /** * Pastes a table into a single cell. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ singleCellTable = "SingleCellTable", /** * Continues numbering from the previous list. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ listContinueNumbering = "ListContinueNumbering", /** * Restarts numbering for the new list. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ listRestartNumbering = "ListRestartNumbering", /** * Appends the pasted table to the existing table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableAppendTable = "TableAppendTable", /** * Inserts the pasted table as new rows. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableInsertAsRows = "TableInsertAsRows", /** * Inserts the pasted table with its original formatting. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableOriginalFormatting = "TableOriginalFormatting", /** * Pastes a chart as a picture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ chartPicture = "ChartPicture", /** * Pastes a chart as an editable chart. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ chart = "Chart", /** * Pastes a chart with a link to the source data. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ chartLinked = "ChartLinked", /** * Applies the original formatting of the pasted content. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formatOriginalFormatting = "FormatOriginalFormatting", /** * Applies surrounding formatting with emphasis. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formatSurroundingFormattingWithEmphasis = "FormatSurroundingFormattingWithEmphasis", /** * Pastes content as plain text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formatPlainText = "FormatPlainText", /** * Overwrites existing cells with the pasted table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableOverwriteCells = "TableOverwriteCells", /** * Combines the pasted list with an existing list. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ listCombineWithExistingList = "ListCombineWithExistingList", /** * Prevents merging the pasted list with an existing list. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ listDontMerge = "ListDontMerge", /** * Uses the destination styles for the pasted content. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useDestinationStylesRecovery = "UseDestinationStylesRecovery", } /** - * Specifies the kind of reference to insert. + * Specifies the type of reference to insert. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - enum ReferenceKind { + enum ReferenceType { /** - * Inserts the full text of the referenced item. + * Refers to a numbered item in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - contentText = "ContentText", + numberedItem = "NumberedItem", /** - * Inserts the number of the referenced item with relative context. + * Refers to a heading in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - numberRelativeContext = "NumberRelativeContext", + heading = "Heading", /** - * Inserts only the number of the referenced item without context. + * Refers to a bookmark in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - numberNoContext = "NumberNoContext", + bookmark = "Bookmark", /** - * Inserts the number of the referenced item with full context. + * Refers to a footnote in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - numberFullContext = "NumberFullContext", - /** - * Inserts the entire caption of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - entireCaption = "EntireCaption", - /** - * Inserts only the label and number of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - onlyLabelAndNumber = "OnlyLabelAndNumber", - /** - * Inserts only the caption text of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - onlyCaptionText = "OnlyCaptionText", - /** - * Inserts the footnote number of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - footnoteNumber = "FootnoteNumber", - /** - * Inserts the endnote number of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - endnoteNumber = "EndnoteNumber", - /** - * Inserts the page number of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - pageNumber = "PageNumber", - /** - * Inserts the position of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - position = "Position", - /** - * Inserts the formatted footnote number of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - footnoteNumberFormatted = "FootnoteNumberFormatted", - /** - * Inserts the formatted endnote number of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - endnoteNumberFormatted = "EndnoteNumberFormatted", - } - /** - * Specifies the type of reference to insert. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReferenceType { - /** - * Refers to a numbered item in the document. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - numberedItem = "NumberedItem", - /** - * Refers to a heading in the document. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - heading = "Heading", - /** - * Refers to a bookmark in the document. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - bookmark = "Bookmark", - /** - * Refers to a footnote in the document. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnote = "Footnote", /** * Refers to an endnote in the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnote = "Endnote", } @@ -147588,71 +145380,61 @@ declare namespace Word { * Specifies the type of selection in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum SelectionType { /** * No selection is made. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noSelection = "NoSelection", /** * Represents an insertion point (IP) selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ insertionPoint = "InsertionPoint", /** * Represents a normal selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ normal = "Normal", /** * Represents a frame selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ frame = "Frame", /** * Represents a column selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ column = "Column", /** * Represents a row selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ row = "Row", /** * Represents a block selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ block = "Block", /** * Represents an inline shape selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ inlineShape = "InlineShape", /** * Represents a shape selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selectionShape = "SelectionShape", } @@ -147660,57 +145442,49 @@ declare namespace Word { * Specifies the type of field to sort by. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum SortFieldType { /** * Sorts content alphanumerically. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ alphanumeric = "Alphanumeric", /** * Sorts content numerically. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ numeric = "Numeric", /** * Sorts content by date. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ date = "Date", /** * Sorts content by syllables. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ syllable = "Syllable", /** * Sorts content using the Japanese JIS standard. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ japanJis = "JapanJis", /** * Sorts content by stroke count. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ stroke = "Stroke", /** * Sorts content using the Korean KS standard. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ koreaKs = "KoreaKs", } @@ -147718,22 +145492,19 @@ declare namespace Word { * Specifies the sort order. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum SortOrder { /** * Sorts in ascending order. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ascending = "Ascending", /** * Sorts in descending order. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ descending = "Descending", } @@ -147741,397 +145512,75 @@ declare namespace Word { * Specifies where and what type of cells to add to an existing table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum TableCellInsertionLocation { /** * Inserts new cells to the left of the selected cells. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shiftRight = "ShiftRight", /** * Inserts new cells above the selected cells. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shiftDown = "ShiftDown", /** * Inserts an entire row above the row that contains the selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shiftRowDown = "ShiftRowDown", /** * Inserts an entire column to the left of the column that contains the selection. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shiftColumnRight = "ShiftColumnRight", } - /** - * Specifies the predefined table formatting options. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TableFormat { - /** - * No table format is applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", - /** - * Applies the simple 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - simple1 = "Simple1", - /** - * Applies the simple 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - simple2 = "Simple2", - /** - * Applies the simple 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - simple3 = "Simple3", - /** - * Applies the classic 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - classic1 = "Classic1", - /** - * Applies the classic 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - classic2 = "Classic2", - /** - * Applies the classic 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - classic3 = "Classic3", - /** - * Applies the classic 4 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - classic4 = "Classic4", - /** - * Applies the colorful 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - colorful1 = "Colorful1", - /** - * Applies the colorful 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - colorful2 = "Colorful2", - /** - * Applies the colorful 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - colorful3 = "Colorful3", - /** - * Applies the columns 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - columns1 = "Columns1", - /** - * Applies the columns 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - columns2 = "Columns2", - /** - * Applies the columns 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - columns3 = "Columns3", - /** - * Applies the columns 4 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - columns4 = "Columns4", - /** - * Applies the columns 5 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - columns5 = "Columns5", - /** - * Applies the grid 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - grid1 = "Grid1", - /** - * Applies the grid 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - grid2 = "Grid2", - /** - * Applies the grid 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - grid3 = "Grid3", - /** - * Applies the grid 4 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - grid4 = "Grid4", - /** - * Applies the grid 5 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - grid5 = "Grid5", - /** - * Applies the grid 6 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - grid6 = "Grid6", - /** - * Applies the grid 7 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - grid7 = "Grid7", - /** - * Applies the grid 8 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - grid8 = "Grid8", - /** - * Applies the list 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list1 = "List1", - /** - * Applies the list 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list2 = "List2", - /** - * Applies the list 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list3 = "List3", - /** - * Applies the list 4 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list4 = "List4", - /** - * Applies the list 5 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list5 = "List5", - /** - * Applies the list 6 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list6 = "List6", - /** - * Applies the list 7 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list7 = "List7", - /** - * Applies the list 8 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list8 = "List8", - /** - * Applies the 3D effects 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - threeDEffects1 = "ThreeDEffects1", - /** - * Applies the 3D effects 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - threeDEffects2 = "ThreeDEffects2", - /** - * Applies the 3D effects 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - threeDEffects3 = "ThreeDEffects3", - /** - * Applies the contemporary table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - contemporary = "Contemporary", - /** - * Applies the elegant table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - elegant = "Elegant", - /** - * Applies the professional table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - professional = "Professional", - /** - * Applies the subtle 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - subtle1 = "Subtle1", - /** - * Applies the subtle 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - subtle2 = "Subtle2", - /** - * Applies the web 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - web1 = "Web1", - /** - * Applies the web 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - web2 = "Web2", - /** - * Applies the web 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - web3 = "Web3", - } /** * Specifies the orientation of text in a text frame or shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum TextOrientation { /** * Text is horizontal. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontal = "Horizontal", /** * Text is vertical with letters rotated 90 degrees clockwise. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upward = "Upward", /** * Text is vertical with letters rotated 90 degrees counterclockwise. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ downward = "Downward", /** * Text is vertical and reads downward from the top, right to left. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ verticalFarEast = "VerticalFarEast", /** * Text is horizontal but from right to left to accommodate right-to-left languages. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalRotatedFarEast = "HorizontalRotatedFarEast", /** * Text is vertical and reads downward from the top, left to right. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ vertical = "Vertical", } @@ -148140,8 +145589,7 @@ declare namespace Word { The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class Bookmark extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -148150,56 +145598,49 @@ declare namespace Word { * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** * Specifies the ending character position of the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end: number; /** * Returns `true` if the bookmark is a table column. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isColumn: boolean; /** * Returns `true` if the bookmark is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly isEmpty: boolean; /** * Returns the name of the `Bookmark` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly name: string; /** * Specifies the starting character position of the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start: number; /** * Returns the story type for the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** @@ -148214,8 +145655,7 @@ declare namespace Word { * Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param name The name of the new bookmark. */ @@ -148224,16 +145664,14 @@ declare namespace Word { * Deletes the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete(): void; /** * Selects the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ select(): void; /** @@ -148275,8 +145713,7 @@ declare namespace Word { * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class BookmarkCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -148299,8 +145736,7 @@ declare namespace Word { * Determines whether the specified bookmark exists. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param name A bookmark name than cannot include more than 40 characters or more than one word. * @returns `true` if the bookmark exists. @@ -148352,127 +145788,109 @@ declare namespace Word { * Specifies the type of story in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum StoryType { /** * Main text story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ mainText = "MainText", /** * Footnotes story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnotes = "Footnotes", /** * Endnotes story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnotes = "Endnotes", /** * Comments story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ comments = "Comments", /** * Text frame story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ textFrame = "TextFrame", /** * Even pages header story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ evenPagesHeader = "EvenPagesHeader", /** * Primary header story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ primaryHeader = "PrimaryHeader", /** * Even pages footer story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ evenPagesFooter = "EvenPagesFooter", /** * Primary footer story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ primaryFooter = "PrimaryFooter", /** * First page header story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ firstPageHeader = "FirstPageHeader", /** * First page footer story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ firstPageFooter = "FirstPageFooter", /** * Footnote separator story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnoteSeparator = "FootnoteSeparator", /** * Footnote continuation separator story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnoteContinuationSeparator = "FootnoteContinuationSeparator", /** * Footnote continuation notice story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ footnoteContinuationNotice = "FootnoteContinuationNotice", /** * Endnote separator story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnoteSeparator = "EndnoteSeparator", /** * Endnote continuation separator story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnoteContinuationSeparator = "EndnoteContinuationSeparator", /** * Endnote continuation notice story. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ endnoteContinuationNotice = "EndnoteContinuationNotice", } @@ -148481,8 +145899,7 @@ declare namespace Word { indexes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class Index extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -148491,8 +145908,7 @@ declare namespace Word { * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** @@ -148500,8 +145916,7 @@ declare namespace Word { See `IndexFilter` for available values. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; /** @@ -148509,32 +145924,28 @@ declare namespace Word { the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; /** * Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** * Gets the number of columns for each page of the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly numberOfColumns: number; /** * Specifies if page numbers are aligned with the right margin in the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly rightAlignPageNumbers: boolean; /** @@ -148542,32 +145953,28 @@ declare namespace Word { one heading and words that begin with "A" are under another). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly separateAccentedLetterHeadings: boolean; /** * Specifies the sorting criteria for the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable"; /** * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * Gets the index type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly type: Word.IndexType | "Indent" | "Runin"; /** @@ -148582,8 +145989,7 @@ declare namespace Word { * Deletes this index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ delete(): void; /** @@ -148625,8 +146031,7 @@ declare namespace Word { * A collection of {@link Word.Index} objects that represents all the indexes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class IndexCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -148637,8 +146042,7 @@ declare namespace Word { * Returns an `Index` object that represents a new index added to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range where you want the index to appear. The index replaces the range, if the range is not collapsed. * @param indexAddOptions Optional. The options for adding the index. @@ -148648,8 +146052,7 @@ declare namespace Word { * Gets the `IndexFormat` value that represents the formatting for the indexes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ getFormat(): OfficeExtension.ClientResult; /** @@ -148666,8 +146069,7 @@ declare namespace Word { * Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param range The range whose text is marked with an `XE` field throughout the document. * @param markAllEntriesOptions Optional. The options for marking all entries. @@ -148709,176 +146111,96 @@ declare namespace Word { * Represents options for creating an index in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface IndexAddOptions { - /** - * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. - See `HeadingSeparator` for available values. The default value is `blankLine`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; - /** - * If provided, specifies the sorting language to be used for the index being added. - See `LanguageId` for available values. The default value is the installed language of the Word application. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - /** - * If provided, specifies the number of columns for each page of the index. - Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - numberOfColumns?: number; - /** - * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - rightAlignPageNumbers?: boolean; - /** - * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - separateAccentedLetterHeadings?: boolean; - /** - * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `stroke`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; - /** - * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. - Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `indent`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - type?: Word.IndexType | "Indent" | "Runin"; - } - /** - * Represents options for marking all index entries in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - interface IndexMarkAllEntriesOptions { + interface IndexAddOptions { /** - * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. + See `HeadingSeparator` for available values. The default value is `blankLine`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - bold?: boolean; + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; /** - * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * If provided, specifies the sorting language to be used for the index being added. + See `LanguageId` for available values. The default value is the installed language of the Word application. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - bookmarkName?: string; + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * If provided, specifies the number of columns for each page of the index. + Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - crossReference?: string; + numberOfColumns?: number; /** - * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - crossReferenceAutoText?: string; + rightAlignPageNumbers?: boolean; /** - * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". - Either this property or `entryAutoText` must be provided. + * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - entry?: string; + separateAccentedLetterHeadings?: boolean; /** - * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". - Either this property or `entry` must be provided. + * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `stroke`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - entryAutoText?: string; + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; /** - * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. + Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `indent`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - italic?: boolean; + type?: Word.IndexType | "Indent" | "Runin"; } /** - * Represents options for marking an index entry in a Word document. + * Represents options for marking all index entries in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - interface IndexMarkEntryOptions { + interface IndexMarkAllEntriesOptions { /** * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bold?: boolean; /** * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bookmarkName?: string; /** * If provided, specifies the cross-reference that will appear in the index. The default value is "". * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ crossReference?: string; /** * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ crossReferenceAutoText?: string; /** @@ -148886,8 +146208,7 @@ declare namespace Word { Either this property or `entryAutoText` must be provided. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entry?: string; /** @@ -148895,68 +146216,52 @@ declare namespace Word { Either this property or `entry` must be provided. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entryAutoText?: string; /** * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ italic?: boolean; - /** - * If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only). The default value is `false`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - reading?: boolean; } /** * Specifies the type of separator to use for headings. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum HeadingSeparator { /** * No separator is used for headings. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * A blank line is used as a separator for headings. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ blankLine = "BlankLine", /** * A single letter is used as a separator for headings. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ letter = "Letter", /** * A lowercase letter is used as a separator for headings. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ letterLow = "LetterLow", /** * A full-width letter is used as a separator for headings. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ letterFull = "LetterFull", } @@ -148964,233 +146269,119 @@ declare namespace Word { * Represents the position of a dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum DropPosition { /** * Represents that there's no dropped capital letter. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Represents a normal dropped capital letter. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ normal = "Normal", /** * Represents a dropped capital letter in the margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ margin = "Margin", } - /** - * Represents the type of line spacing. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineSpacing { - /** - * Represents single line spacing. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - single = "Single", - /** - * Represents 1.5 line spacing. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - onePt5 = "OnePt5", - /** - * Represents double line spacing. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - double = "Double", - /** - * Represents at least line spacing. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - atLeast = "AtLeast", - /** - * Represents exact line spacing. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - exactly = "Exactly", - /** - * Represents multiple line spacing. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - multiple = "Multiple", - } /** * Represents the alignment of a tab stop. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum TabAlignment { /** * Represents that the tab stop is aligned to the left. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ left = "Left", /** * Represents that the tab stop is aligned to the center. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ center = "Center", /** * Represents that the tab stop is aligned to the right. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ right = "Right", /** * Represents that the tab stop is aligned to the decimal point. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ decimal = "Decimal", /** * Represents that the tab stop is aligned to the bar. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bar = "Bar", /** * Represents that the tab stop is aligned to the list. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ list = "List", } - /** - * Represents the type of tight wrap for a text box. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TextboxTightWrap { - /** - * Represents that there's no tight wrap. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", - /** - * Represents tight wrap around all lines. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - all = "All", - /** - * Represents tight wrap around the first and last lines. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - firstAndLastLines = "FirstAndLastLines", - /** - * Represents tight wrap around the first line only. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - firstLineOnly = "FirstLineOnly", - /** - * Represents tight wrap around the last line only. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - lastLineOnly = "LastLineOnly", - } /** * Specifies the filter type for an index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum IndexFilter { /** * No filter is applied. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Aiueo filter is applied. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ aiueo = "Aiueo", /** * Akasatana filter is applied. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ akasatana = "Akasatana", /** * Chosung filter is applied. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ chosung = "Chosung", /** * Low filter is applied. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ low = "Low", /** * Medium filter is applied. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ medium = "Medium", /** * Full filter is applied. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ full = "Full", } @@ -149198,57 +146389,49 @@ declare namespace Word { * Specifies the format for an index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum IndexFormat { /** * Template format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ template = "Template", /** * Classic format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ classic = "Classic", /** * Fancy format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fancy = "Fancy", /** * Modern format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ modern = "Modern", /** * Bulleted format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bulleted = "Bulleted", /** * Formal format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formal = "Formal", /** * Simple format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ simple = "Simple", } @@ -149256,22 +146439,19 @@ declare namespace Word { * Specifies how an index is sorted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum IndexSortBy { /** * Sort by stroke. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ stroke = "Stroke", /** * Sort by syllable. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ syllable = "Syllable", } @@ -149279,22 +146459,19 @@ declare namespace Word { * Specifies the type of index to create. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum IndexType { /** * Creates an indented index. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ indent = "Indent", /** * Creates a run-in index. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ runin = "Runin", } @@ -149302,50 +146479,43 @@ declare namespace Word { * Specifies the tab leader style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum TabLeader { /** * Spaces are used as the tab leader. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaces = "Spaces", /** * Dots are used as the tab leader. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ dots = "Dots", /** * Dashes are used as the tab leader. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ dashes = "Dashes", /** * Lines are used as the tab leader. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lines = "Lines", /** * Heavy lines are used as the tab leader. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ heavy = "Heavy", /** * Middle dots are used as the tab leader. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ middleDot = "MiddleDot", } @@ -149353,92 +146523,79 @@ declare namespace Word { * Specifies the area of a table to which to apply special style formatting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ConditionCode { /** * Applies formatting to the first row in a table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ firstRow = "FirstRow", /** * Applies formatting to the last row in a table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lastRow = "LastRow", /** * Applies formatting to odd-numbered rows. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oddRowBanding = "OddRowBanding", /** * Applies formatting to even-numbered rows. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ evenRowBanding = "EvenRowBanding", /** * Applies formatting to the first column in a table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ firstColumn = "FirstColumn", /** * Applies formatting to the last column in a table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lastColumn = "LastColumn", /** * Applies formatting to odd-numbered columns. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oddColumnBanding = "OddColumnBanding", /** * Applies formatting to even-numbered columns. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ evenColumnBanding = "EvenColumnBanding", /** * Applies formatting to the last cell in the first row. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ topRightCell = "TopRightCell", /** * Applies formatting to the first cell in the first row. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ topLeftCell = "TopLeftCell", /** * Applies formatting to the last cell in the table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bottomRightCell = "BottomRightCell", /** * Applies formatting to first cell in the last row of the table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bottomLeftCell = "BottomLeftCell", } @@ -149446,36 +146603,31 @@ declare namespace Word { * Specifies a range of cells to be deleted from a table in a delete cells action or the behavior of the remaining cells after the deletion has occurred. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum DeleteCells { /** * Shift remaining cells left in the row where the deletion occurred after a cell or range of cells has been deleted. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shiftLeft = "ShiftLeft", /** * Shift remaining cells up in the column where the deletion occurred after a cell or range of cells has been deleted. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shiftUp = "ShiftUp", /** * Delete the entire row of cells from the table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entireRow = "EntireRow", /** * Delete the entire column of cells from the table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entireColumn = "EntireColumn", } @@ -149483,29 +146635,25 @@ declare namespace Word { * Specifies the rule for determining the height of the specified cells or rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum RowHeightRule { /** * The row height is adjusted to accommodate the tallest value in the row. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ auto = "Auto", /** * The row height is set to a minimum value. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ atLeast = "AtLeast", /** * The row height is set to an exact value. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ exactly = "Exactly", } @@ -149513,22 +146661,19 @@ declare namespace Word { * Specifies the direction in which Microsoft Word orders cells in the specified table or row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum TableDirection { /** * The table is arranged with the first column in the rightmost position. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightToLeft = "RightToLeft", /** * The table is arranged with the first column in the leftmost position. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftToRight = "LeftToRight", } @@ -149536,36 +146681,31 @@ declare namespace Word { * Specifies the character used to separate fields in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum TableFieldSeparator { /** * Uses the paragraph marker. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ paragraph = "Paragraph", /** * Uses the tab. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tab = "Tab", /** * Uses the comma. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ comma = "Comma", /** * Uses the default list separator. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ defaultListSeparator = "DefaultListSeparator", } @@ -149573,309 +146713,265 @@ declare namespace Word { * Specifies the table format to apply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum TableFormatType { /** * Applies no formatting to the table. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Applies the Simple1 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ simple1 = "Simple1", /** * Applies the Simple2 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ simple2 = "Simple2", /** * Applies the Simple3 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ simple3 = "Simple3", /** * Applies the Classic1 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ classic1 = "Classic1", /** * Applies the Classic2 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ classic2 = "Classic2", /** * Applies the Classic3 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ classic3 = "Classic3", /** * Applies the Classic4 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ classic4 = "Classic4", /** * Applies the Colorful1 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ colorful1 = "Colorful1", /** * Applies the Colorful2 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ colorful2 = "Colorful2", /** * Applies the Colorful3 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ colorful3 = "Colorful3", /** * Applies the Columns1 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columns1 = "Columns1", /** * Applies the Columns2 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columns2 = "Columns2", /** * Applies the Columns3 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columns3 = "Columns3", /** * Applies the Columns4 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columns4 = "Columns4", /** * Applies the Columns5 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columns5 = "Columns5", /** * Applies the Grid1 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grid1 = "Grid1", /** * Applies the Grid2 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grid2 = "Grid2", /** * Applies the Grid3 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grid3 = "Grid3", /** * Applies the Grid4 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grid4 = "Grid4", /** * Applies the Grid5 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grid5 = "Grid5", /** * Applies the Grid6 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grid6 = "Grid6", /** * Applies the Grid7 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grid7 = "Grid7", /** * Applies the Grid8 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grid8 = "Grid8", /** * Applies the List1 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ list1 = "List1", /** * Applies the List2 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ list2 = "List2", /** * Applies the List3 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ list3 = "List3", /** * Applies the List4 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ list4 = "List4", /** * Applies the List5 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ list5 = "List5", /** * Applies the List6 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ list6 = "List6", /** * Applies the List7 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ list7 = "List7", /** * Applies the List8 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ list8 = "List8", /** * Applies the 3D Effects1 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ threeDEffects1 = "ThreeDEffects1", /** * Applies the 3D Effects2 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ threeDEffects2 = "ThreeDEffects2", /** * Applies the 3D Effects3 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ threeDEffects3 = "ThreeDEffects3", /** * Applies the Contemporary table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ contemporary = "Contemporary", /** * Applies the Elegant table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ elegant = "Elegant", /** * Applies the Professional table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ professional = "Professional", /** * Applies the Subtle1 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ subtle1 = "Subtle1", /** * Applies the Subtle2 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ subtle2 = "Subtle2", /** * Applies the Web1 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ web1 = "Web1", /** * Applies the Web2 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ web2 = "Web2", /** * Applies the Web3 table format. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ web3 = "Web3", } @@ -149883,88 +146979,77 @@ declare namespace Word { * Represents the options for the {@link Word.Table | Table.autoFormat} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableAutoFormatOptions { /** * If provided, specifies whether to apply borders of the specified format. The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ applyBorders?: boolean; /** * If provided, specifies whether to apply color of the specified format. The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ applyColor?: boolean; /** * If provided, specifies whether to apply first column formatting of the specified format. The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ applyFirstColumn?: boolean; /** * If provided, specifies whether to apply font of the specified format. The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ applyFont?: boolean; /** * If provided, specifies whether to apply heading row formatting of the specified format. The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ applyHeadingRows?: boolean; /** * If provided, specifies whether to apply last column formatting of the specified format. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ applyLastColumn?: boolean; /** * If provided, specifies whether to apply last row formatting of the specified format. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ applyLastRow?: boolean; /** * If provided, specifies whether to apply shading of the specified format. The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ applyShading?: boolean; /** * If provided, specifies whether to decrease the width of the table columns as much as possible without changing the way text wraps in the cells. The default value is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ autoFit?: boolean; /** * If provided, specifies the format to apply. The default value is `simple1`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ format?: Word.TableFormatType | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; } @@ -149972,32 +147057,28 @@ declare namespace Word { * Represents the options for the {@link Word.TableCellCollection | TableCellCollection.split} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableCellCollectionSplitOptions { /** * If provided, specifies whether to merge the cells with one another before splitting them. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ mergeBeforeSplit?: boolean; /** * If provided, specifies the number of columns that the group of cells is to be split into. The default value is 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ numColumns?: number; /** * If provided, specifies the number of rows that the group of cells is to be split into. The default value is 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ numRows?: number; } @@ -150005,24 +147086,21 @@ declare namespace Word { * Represents the options for the {@link Word.TableCell | TableCell.formula} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableCellFormulaOptions { /** * If provided, specifies the mathematical formula you want the = (Formula) field to evaluate. Spreadsheet-type references to table cells are valid. For example, "=SUM(A4:C4)" specifies the first three values in the fourth row. For more information about the = (Formula) field, see {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Field codes: = (Formula) field}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formula?: string; /** * If provided, specifies a format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}. For information about the types of formats you can apply, see the Numeric Picture (#) field switch. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ numFormat?: string; } @@ -150030,24 +147108,21 @@ declare namespace Word { * Represents the options for the {@link Word.Table | Table.convertToText}, {@link Word.TableRow | TableRow.convertToText}, and {@link Word.TableRowCollection | TableRowCollection.convertToText} methods. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableConvertToTextOptions { /** * If provided, specifies whether to convert the nested tables to text. This property is ignored if the `separator` property isn't set to `paragraph`. The default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ nestedTables?: boolean; /** * If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows). The default is `tab`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ separator?: Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | "DefaultListSeparator"; } @@ -150055,144 +147130,126 @@ declare namespace Word { * Represents the options for the {@link Word.Table | Table.sort} method. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableSortOptions { /** * If provided, specifies whether to use bidirectional sort. `true` means to sort based on right-to-left language rules. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bidirectionalSort?: boolean; /** * If provided, specifies whether sorting is case-sensitive. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ caseSensitive?: boolean; /** * If provided, specifies whether to exclude the header row from the sort operation. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ excludeHeader?: boolean; /** * If provided, specifies the first field to sort by. Microsoft Word sorts by `fieldNumber`, then by `fieldNumber2`, and finally by `fieldNumber3`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fieldNumber?: string; /** * If provided, specifies the second field to sort by. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fieldNumber2?: string; /** * If provided, specifies the third field to sort by. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fieldNumber3?: string; /** * If provided, specifies whether to ignore Arabic character alef lam when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ignoreArabicThe?: boolean; /** * If provided, specifies whether to ignore bidirectional control characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ignoreDiacritics?: boolean; /** * If provided, specifies whether to ignore Hebrew characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ignoreHebrew?: boolean; /** * If provided, specifies whether to ignore kashida when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ignoreKashida?: boolean; /** * If provided, specifies the sorting language. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** * If provided, specifies the type of the first field to sort by. The default value is `alphanumeric`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sortFieldType?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; /** * If provided, specifies the type of the second field to sort by. The default value is `alphanumeric`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sortFieldType2?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; /** * If provided, specifies the type of the third field to sort by. The default value is `alphanumeric`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sortFieldType3?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; /** * If provided, specifies the sort order of the first field to sort by. The default value is `ascending`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sortOrder?: Word.SortOrder | "Ascending" | "Descending"; /** * If provided, specifies the sort order of the second field to sort by. The default value is `ascending`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sortOrder2?: Word.SortOrder | "Ascending" | "Descending"; /** * If provided, specifies the sort order of the third field to sort by. The default value is `ascending`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sortOrder3?: Word.SortOrder | "Ascending" | "Descending"; } @@ -150200,8 +147257,7 @@ declare namespace Word { * Represents a list of the names of all the available fonts. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class FontNameCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -150210,16 +147266,14 @@ declare namespace Word { * Returns the number of items in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ getCount(): OfficeExtension.ClientResult; /** * Gets the font name at the specified index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param index The zero-based index of the item to retrieve. */ @@ -150259,8 +147313,7 @@ declare namespace Word { * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class ListTemplateCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -150276,7 +147329,7 @@ declare namespace Word { * * @param options Optional. Options for adding a new list template. */ - add(options?: Word.ListTemplateCollectionAddOptions): Word.ListTemplate; + add(options?: Word.ListTemplateAddOptions): Word.ListTemplate; /** * Gets a `ListTemplate` object by its index in the collection. * @@ -150326,7 +147379,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface ListTemplateCollectionAddOptions { + interface ListTemplateAddOptions { /** * If provided, specifies the name of the list template to be added. * @@ -150348,8 +147401,7 @@ declare namespace Word { * Represents a gallery of list templates of the same {@link Word.ListTemplateGalleryType}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class ListTemplateGallery extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -150358,8 +147410,7 @@ declare namespace Word { * Returns a `ListTemplateCollection` object that represents all the list templates for the specified list gallery. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readonly listTemplates: Word.ListTemplateCollection; /** @@ -150395,8 +147446,7 @@ declare namespace Word { * Contains a collection of {@link Word.ListTemplateGallery} objects available through the three bullets-and-numbering buttons on the **Home** tab (see {@link https://support.microsoft.com/office/6c06ef65-27ad-4893-80c9-0b944cb81f5f | Define new bullets, numbers, and multilevel lists} for how to access in the Word UI). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ class ListTemplateGalleryCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -150407,8 +147457,7 @@ declare namespace Word { * Gets a `ListTemplateGallery` object by its type in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param type The type of list template gallery to retrieve. */ @@ -150417,8 +147466,7 @@ declare namespace Word { * Gets a `ListTemplateGallery` object by its type in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] * * @param type The type of list template gallery to retrieve. */ @@ -150463,29 +147511,25 @@ declare namespace Word { * Describes the types of list template galleries available. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum ListTemplateGalleryType { /** * Represents the bullet list gallery. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bullets = "Bullets", /** * Represents the number list gallery. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ number = "Number", /** * Represents the outline number list gallery. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ outlineNumbered = "OutlineNumbered", } @@ -150493,36 +147537,31 @@ declare namespace Word { * Represents the types of {@link Word.CoauthoringLock | coauthoring locks}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum CoauthoringLockType { /** * Reserved for future use. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ none = "None", /** * Represents that the lock is a reservation. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ reservation = "Reservation", /** * Represents that the lock is ephemeral. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ephemeral = "Ephemeral", /** * Represents that the lock has changed. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ changed = "Changed", } @@ -150530,36 +147569,31 @@ declare namespace Word { * Represents the classes of users who can edit authorized portions of a protected (read-only) document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ enum EditorType { /** * Represents the current user of the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ current = "Current", /** * Represents the Editors group for documents that use Information Rights Management. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ editors = "Editors", /** * Represents all users who open a document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ everyone = "Everyone", /** * Represents the Owners group for documents that use Information Rights Management. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ owners = "Owners", } @@ -150593,16 +147627,14 @@ declare namespace Word { * Gets a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ nextRange?: Word.Interfaces.RangeUpdateData; /** * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeUpdateData; } @@ -150616,8 +147648,7 @@ declare namespace Word { * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeUpdateData; } @@ -150860,8 +147891,7 @@ declare namespace Word { * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeUpdateData; } @@ -150879,8 +147909,7 @@ declare namespace Word { * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeUpdateData; } @@ -150988,32 +148017,28 @@ declare namespace Word { * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bottomPadding?: number; /** * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftPadding?: number; /** * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightPadding?: number; /** * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ topPadding?: number; } @@ -151354,48 +148379,42 @@ declare namespace Word { * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areGrammaticalErrorsShown?: boolean; /** * Specifies whether to use the default math settings when creating new equations. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areMathDefaultsUsed?: boolean; /** * Specifies whether to disable features introduced after a specified version. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areNewerFeaturesDisabled?: boolean; /** * Specifies whether Microsoft Word underlines spelling errors in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areSpellingErrorsShown?: boolean; /** * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areStylesUpdatedOnOpen?: boolean; /** * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTrueTypeFontsEmbedded?: boolean; /** @@ -151430,120 +148449,105 @@ declare namespace Word { * Specifies the interval (in points) between the default tab stops in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ defaultTabStop?: number; /** * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ defaultTargetFrame?: string; /** * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ doNotEmbedSystemFonts?: boolean; /** * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ encryptionProvider?: string; /** * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** * Specifies the line break control level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formattingIsNextLevelShown?: boolean; /** * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formattingIsUserStyleNameShown?: boolean; /** * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridDistanceHorizontal?: number; /** * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridDistanceVertical?: number; /** * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridIsOriginFromMargin?: boolean; /** * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridOriginHorizontal?: number; /** * Specifies the vertical origin point for the invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridOriginVertical?: number; /** * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridSpaceBetweenHorizontalLines?: number; /** * Specifies the interval for vertical character gridlines in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridSpaceBetweenVerticalLines?: number; /** @@ -151557,184 +148561,161 @@ declare namespace Word { * Specifies the width of the hyphenation zone, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hyphenationZone?: number; /** * Specifies whether automatic formatting options override formatting restrictions. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isAutoFormatOverrideOn?: boolean; /** * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isChartDataPointTracked?: boolean; /** * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isCompatible?: boolean; /** * Specifies whether the document is final. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFinal?: boolean; /** * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFontsSubsetSaved?: boolean; /** * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormsDataPrinted?: boolean; /** * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormsDataSaved?: boolean; /** * Specifies whether a grammar check has been run on the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isGrammarChecked?: boolean; /** * Specifies whether Word kerns half-width Latin characters and punctuation marks. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isKerningByAlgorithm?: boolean; /** * Specifies whether to embed speech and handwriting data. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLinguisticDataEmbedded?: boolean; /** * Specifies whether Word optimizes the document for Word 97. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isOptimizedForWord97?: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPostScriptPrintedOverText?: boolean; /** * Specifies whether users can change the Quick Style set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isQuickStyleSetLocked?: boolean; /** * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isReadOnlyRecommended?: boolean; /** * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSnappedToGrid?: boolean; /** * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSnappedToShapes?: boolean; /** * Specifies whether spelling has been checked throughout the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSpellingChecked?: boolean; /** * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isStyleEnforced?: boolean; /** * Specifies whether users can change the document theme. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isThemeLocked?: boolean; /** * Specifies whether the document was created or opened by the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isUserControl?: boolean; /** * Specifies the character spacing adjustment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; /** @@ -151748,152 +148729,133 @@ declare namespace Word { * Specifies the kinsoku characters after which Word will not break a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noLineBreakAfter?: string; /** * Specifies the kinsoku characters before which Word will not break a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noLineBreakBefore?: string; /** * Sets a password that must be supplied to open the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ password?: string; /** * Specifies whether revision marks are printed with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ printRevisions?: boolean; /** * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutSizeX?: number; /** * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutSizeY?: number; /** * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingModeIsLayoutFrozen?: boolean; /** * Specifies whether Word removes user information upon saving. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ removePersonalInformationOnSave?: boolean; /** * Specifies the encoding used when saving the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Specifies the encoding for saving as encoded text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Specifies how Word marks line and paragraph breaks in text files. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; /** * Specifies whether to track formatting changes when change tracking is on. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackFormatting?: boolean; /** * Specifies whether to mark moved text when Track Changes is on. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackMoves?: boolean; /** * Specifies whether changes are tracked in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackRevisions?: boolean; /** * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackedChangesAreDateAndTimeRemoved?: boolean; /** * Sets a password for saving changes to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ writePassword?: string; /** * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlAreAdvancedErrorsShown?: boolean; /** * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlIsXsltUsedWhenSaving?: boolean; /** * Specifies the path and file name for the XSLT to apply when saving a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlSaveThroughXslt?: string; } @@ -152410,16 +149372,14 @@ declare namespace Word { * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ level?: number; /** * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: string; } @@ -152538,32 +149498,28 @@ declare namespace Word { * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isAutoUpdated?: boolean; /** * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLocked?: boolean; /** * Specifies if the linked picture is saved with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPictureSavedWithDocument?: boolean; /** * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sourceFullName?: string; } @@ -152671,8 +149627,7 @@ declare namespace Word { * Specifies the name of the list template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: string; /** @@ -152710,40 +149665,35 @@ declare namespace Word { * Specifies the class type for the specified OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ classType?: string; /** * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconIndex?: number; /** * Specifies the text displayed below the icon for the OLE object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconLabel?: string; /** * Specifies the program file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconName?: string; /** * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormattingPreservedOnUpdate?: boolean; } @@ -152761,170 +149711,150 @@ declare namespace Word { * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ next?: Word.Interfaces.WindowUpdateData; /** * Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previous?: Word.Interfaces.WindowUpdateData; /** * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areRulersDisplayed?: boolean; /** * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areThumbnailsDisplayed?: boolean; /** * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ caption?: string; /** * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalPercentScrolled?: number; /** * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDocumentMapVisible?: boolean; /** * Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEnvelopeVisible?: boolean; /** * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isHorizontalScrollBarDisplayed?: boolean; /** * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLeftScrollBarDisplayed?: boolean; /** * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isRightRulerDisplayed?: boolean; /** * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSplit?: boolean; /** * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVerticalRulerDisplayed?: boolean; /** * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVerticalScrollBarDisplayed?: boolean; /** * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVisible?: boolean; /** * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ splitVertical?: number; /** - * Specifies the width of the style area in points. + * Specifies the state of the document window or task window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleAreaWidth?: number; + state?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; /** - * Specifies the vertical scroll position as a percentage of the document length. + * Specifies the width of the style area in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - verticalPercentScrolled?: number; + styleAreaWidth?: number; /** - * Specifies the state of the document window or task window. + * Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + verticalPercentScrolled?: number; } /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ interface WindowCollectionUpdateData { @@ -153177,48 +150107,42 @@ declare namespace Word { * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** * Specifies the character width of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** * Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ combineCharacters?: boolean; /** * Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: number; /** * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitTextWidth?: number; /** * Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grammarChecked?: boolean; /** @@ -153232,8 +150156,7 @@ declare namespace Word { * Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** @@ -153247,16 +150170,14 @@ declare namespace Word { * Specifies the ID for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id?: string; /** * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ kana?: Word.Kana | "Katakana" | "Hiragana"; /** @@ -153291,24 +150212,21 @@ declare namespace Word { * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showAll?: boolean; /** * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spellingChecked?: boolean; /** * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: number; /** @@ -153329,8 +150247,7 @@ declare namespace Word { * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; } @@ -153665,8 +150582,7 @@ declare namespace Word { * Specifies the description of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ description?: string; /** @@ -153743,8 +150659,7 @@ declare namespace Word { * Specifies the title of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ title?: string; /** @@ -153803,16 +150718,14 @@ declare namespace Word { * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columnStripe?: number; /** * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isBreakAcrossPagesAllowed?: boolean; /** @@ -153826,8 +150739,7 @@ declare namespace Word { * Specifies the left indent value (in points) for the rows in the table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftIndent?: number; /** @@ -153841,16 +150753,14 @@ declare namespace Word { * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rowStripe?: number; /** * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** @@ -153911,8 +150821,7 @@ declare namespace Word { * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bookmark?: string; /** @@ -153920,80 +150829,70 @@ declare namespace Word { 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ category?: number; /** * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entrySeparator?: string; /** * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isCategoryHeaderIncluded?: boolean; /** * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEntryFormattingKept?: boolean; /** * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPassimUsed?: boolean; /** * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageNumberSeparator?: string; /** * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageRangeSeparator?: string; /** * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceName?: string; /** * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceSeparator?: string; /** * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; } @@ -154011,80 +150910,70 @@ declare namespace Word { * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBuiltInHeadingStylesUsed?: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldsUsed?: boolean; /** * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areHyperlinksUsedOnWeb?: boolean; /** * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersHiddenOnWeb?: boolean; /** * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersIncluded?: boolean; /** * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersRightAligned?: boolean; /** * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel?: number; /** * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: string; /** * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel?: number; } @@ -154098,96 +150987,84 @@ declare namespace Word { * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBuiltInHeadingStylesUsed?: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldsUsed?: boolean; /** * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areHyperlinksUsedOnWeb?: boolean; /** * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersHiddenOnWeb?: boolean; /** * Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersIncluded?: boolean; /** * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersRightAligned?: boolean; /** * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ captionLabel?: string; /** * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLabelIncluded?: boolean; /** * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel?: number; /** * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: string; /** * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel?: number; } @@ -154404,272 +151281,238 @@ declare namespace Word { * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areAllNonprintingCharactersDisplayed?: boolean; /** * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBackgroundsDisplayed?: boolean; /** * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areCommentsDisplayed?: boolean; /** * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areEditableRangesShaded?: boolean; /** * Specifies whether field codes are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldCodesDisplayed?: boolean; /** * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFormatChangesDisplayed?: boolean; /** * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areInkAnnotationsDisplayed?: boolean; /** * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areInsertionsAndDeletionsDisplayed?: boolean; /** * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areOtherAuthorsVisible?: boolean; /** * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areRevisionsAndCommentsDisplayed?: boolean; /** * Specifies whether table gridlines are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTableGridlinesDisplayed?: boolean; /** * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDraft?: boolean; /** * Specifies whether only the first line of body text is shown in outline view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFirstLineOnlyDisplayed?: boolean; /** * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormatDisplayed?: boolean; /** * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFullScreen?: boolean; /** * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInConflictMode?: boolean; /** * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInPanning?: boolean; /** * Specifies whether the document is being viewed in reading layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInReadingLayout?: boolean; /** * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMailMergeDataView?: boolean; /** * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMainTextLayerVisible?: boolean; /** * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPointerShownAsMagnifier?: boolean; /** * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isReadingLayoutActualView?: boolean; /** * Specifies whether XML tags are visible in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isXmlMarkupVisible?: boolean; /** * Specifies the display mode for tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** * Specifies the page movement type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** * Specifies the width of the revision balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsBalloonWidth?: number; /** * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** * Specifies the document element displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** * Specifies the active window pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** * Specifies the view type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; } @@ -155030,8 +151873,7 @@ declare namespace Word { * Specifies if the `Reviewer` object is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVisible?: boolean; } @@ -155045,16 +151887,14 @@ declare namespace Word { * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ view?: Word.RevisionsView | "Final" | "Original"; } @@ -155074,16 +151914,14 @@ declare namespace Word { * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ movedRange?: Word.Interfaces.RangeUpdateData; /** * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeUpdateData; } @@ -155448,7 +152286,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingUpdateData; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * @@ -155523,72 +152361,63 @@ declare namespace Word { * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ allowPng?: boolean; /** * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ encoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ organizeInFolder?: boolean; /** * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pixelsPerInch?: number; /** * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ relyOnCSS?: boolean; /** * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ relyOnVectorMarkupLanguage?: boolean; /** * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ screenSize?: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** * Specifies the target browser for documents viewed in a web browser. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ targetBrowser?: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useLongFileNames?: boolean; } @@ -155599,29 +152428,27 @@ declare namespace Word { /** An interface for updating data on the `XmlNode` object, for use in `xmlNode.set({ ... })`. */ interface XmlNodeUpdateData { /** - * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - nodeValue?: string; + placeholderText?: string; /** - * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - placeholderText?: string; + text?: string; /** - * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: string; + value?: string; } /** An interface for updating data on the `HtmlDivision` object, for use in `htmlDivision.set({ ... })`. */ interface HtmlDivisionUpdateData { @@ -155629,32 +152456,28 @@ declare namespace Word { * Specifies the left indent value (in points) for this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftIndent?: number; /** * Specifies the right indent (in points) for this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightIndent?: number; /** * Specifies the amount of spacing (in points) after this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaceAfter?: number; /** * Specifies the spacing (in points) before this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaceBefore?: number; } @@ -156617,72 +153440,63 @@ declare namespace Word { * Specifies the ending character position of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: number; /** * Specifies the width in which Word fits the text in the current selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitTextWidth?: number; /** * Specifies whether column selection mode is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isColumnSelectModeActive?: boolean; /** * Specifies whether Extend mode is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isExtendModeActive?: boolean; /** * Specifies whether the beginning of the selection is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isStartActive?: boolean; /** * Specifies whether Word has detected the language of the selected text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageDetected?: boolean; /** * Specifies the orientation of text in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** * Specifies the starting character position of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: number; /** * Specifies the text in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ text?: string; } @@ -156696,24 +153510,21 @@ declare namespace Word { * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeUpdateData; /** * Specifies the ending character position of the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: number; /** * Specifies the starting character position of the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: number; } @@ -156727,16 +153538,14 @@ declare namespace Word { * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeUpdateData; /** * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; } @@ -156758,32 +153567,28 @@ declare namespace Word { * Gets a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ nextRange?: Word.Interfaces.RangeData; /** * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeData; /** * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id?: string; /** * Gets the name of the editor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: string; } @@ -156797,16 +153602,14 @@ declare namespace Word { * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeData; /** * Gets the `RevisionType` for the `Conflict` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; } @@ -156854,8 +153657,7 @@ declare namespace Word { * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ listTemplateGalleries?: Word.Interfaces.ListTemplateGalleryData[]; /** @@ -157185,24 +153987,21 @@ declare namespace Word { * Gets the owner of the lock. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ owner?: Word.Interfaces.CoauthorData; /** * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeData; /** * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; } @@ -157216,40 +154015,35 @@ declare namespace Word { * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ locks?: Word.Interfaces.CoauthoringLockData[]; /** * Gets the email address of the coauthor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ emailAddress?: string; /** * Gets the unique identifier for the `Coauthor` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id?: string; /** * Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMe?: boolean; /** * Gets the display name of the coauthor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: string; } @@ -157263,64 +154057,56 @@ declare namespace Word { * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ authors?: Word.Interfaces.CoauthorData[]; /** * Gets a `ConflictCollection` object that represents all the conflicts in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ conflicts?: Word.Interfaces.ConflictData[]; /** * Gets a `CoauthoringLockCollection` object that represents the locks in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ locks?: Word.Interfaces.CoauthoringLockData[]; /** * Gets a `Coauthor` object that represents the current user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ me?: Word.Interfaces.CoauthorData; /** * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ updates?: Word.Interfaces.CoauthoringUpdateData[]; /** * Gets whether this document can be coauthored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ canCoauthor?: boolean; /** * Gets whether the document can be automatically merged. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ canMerge?: boolean; /** * Gets whether the document has pending updates that have not been accepted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pendingUpdates?: boolean; } @@ -157330,8 +154116,7 @@ declare namespace Word { * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeData; } @@ -157516,32 +154301,28 @@ declare namespace Word { * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bottomPadding?: number; /** * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftPadding?: number; /** * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightPadding?: number; /** * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ topPadding?: number; } @@ -158154,8 +154935,7 @@ declare namespace Word { * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ coauthoring?: Word.Interfaces.CoauthoringData; /** @@ -158197,8 +154977,7 @@ declare namespace Word { * Returns a `ListTemplateCollection` object that represents all the list templates in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ listTemplates?: Word.Interfaces.ListTemplateData[]; /** @@ -158226,8 +155005,7 @@ declare namespace Word { * Returns a `Selection` object that represents the current selection in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selection?: Word.Interfaces.SelectionData; /** @@ -158248,72 +155026,63 @@ declare namespace Word { * Gets the name of the active theme and formatting options. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ activeTheme?: string; /** * Gets the display name of the active theme. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ activeThemeDisplayName?: string; /** * Gets whether Word encrypts file properties for password-protected documents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFilePropertiesPasswordEncrypted?: boolean; /** * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areGrammaticalErrorsShown?: boolean; /** * Specifies whether to use the default math settings when creating new equations. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areMathDefaultsUsed?: boolean; /** * Specifies whether to disable features introduced after a specified version. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areNewerFeaturesDisabled?: boolean; /** * Specifies whether Microsoft Word underlines spelling errors in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areSpellingErrorsShown?: boolean; /** * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areStylesUpdatedOnOpen?: boolean; /** * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTrueTypeFontsEmbedded?: boolean; /** @@ -158341,16 +155110,14 @@ declare namespace Word { * Gets the code name for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ codeName?: string; /** * Gets the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ compatibilityMode?: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current"; /** @@ -158364,152 +155131,133 @@ declare namespace Word { * Gets a random number that Word assigns to changes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ currentRsid?: number; /** * Specifies the interval (in points) between the default tab stops in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ defaultTabStop?: number; /** * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ defaultTargetFrame?: string; /** * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ doNotEmbedSystemFonts?: boolean; /** * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ encryptionProvider?: string; /** * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** * Specifies the line break control level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formattingIsNextLevelShown?: boolean; /** * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formattingIsUserStyleNameShown?: boolean; /** * Gets the name of a document, including the path. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fullName?: string; /** * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridDistanceHorizontal?: number; /** * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridDistanceVertical?: number; /** * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridIsOriginFromMargin?: boolean; /** * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridOriginHorizontal?: number; /** * Specifies the vertical origin point for the invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridOriginVertical?: number; /** * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridSpaceBetweenHorizontalLines?: number; /** * Specifies the interval for vertical character gridlines in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridSpaceBetweenVerticalLines?: number; /** * Gets whether a password is required to open the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hasPassword?: boolean; /** * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hasVbProject?: boolean; /** @@ -158523,240 +155271,210 @@ declare namespace Word { * Specifies the width of the hyphenation zone, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hyphenationZone?: number; /** * Specifies whether automatic formatting options override formatting restrictions. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isAutoFormatOverrideOn?: boolean; /** * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isChartDataPointTracked?: boolean; /** * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isCompatible?: boolean; /** * Specifies whether the document is final. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFinal?: boolean; /** * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFontsSubsetSaved?: boolean; /** * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormsDataPrinted?: boolean; /** * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormsDataSaved?: boolean; /** * Specifies whether a grammar check has been run on the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isGrammarChecked?: boolean; /** * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInAutoSave?: boolean; /** * Gets whether the document is in form design mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInFormsDesign?: boolean; /** * Specifies whether Word kerns half-width Latin characters and punctuation marks. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isKerningByAlgorithm?: boolean; /** * Specifies whether to embed speech and handwriting data. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLinguisticDataEmbedded?: boolean; /** * Gets whether this document is a master document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMasterDocument?: boolean; /** * Specifies whether Word optimizes the document for Word 97. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isOptimizedForWord97?: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPostScriptPrintedOverText?: boolean; /** * Specifies whether users can change the Quick Style set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isQuickStyleSetLocked?: boolean; /** * Gets whether changes to the document cannot be saved to the original document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isReadOnly?: boolean; /** * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isReadOnlyRecommended?: boolean; /** * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSnappedToGrid?: boolean; /** * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSnappedToShapes?: boolean; /** * Specifies whether spelling has been checked throughout the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSpellingChecked?: boolean; /** * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isStyleEnforced?: boolean; /** * Gets whether this document is a subdocument of a master document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSubdocument?: boolean; /** * Specifies whether users can change the document theme. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isThemeLocked?: boolean; /** * Specifies whether the document was created or opened by the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isUserControl?: boolean; /** * Gets whether the VBA project is digitally signed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVbaSigned?: boolean; /** * Gets whether the document is protected with a write password. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isWriteReserved?: boolean; /** * Specifies the character spacing adjustment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; /** @@ -158770,144 +155488,126 @@ declare namespace Word { * Specifies the kinsoku characters after which Word will not break a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noLineBreakAfter?: string; /** * Specifies the kinsoku characters before which Word will not break a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noLineBreakBefore?: string; /** * Gets the encoding used to open the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ openEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Gets the title of the original document after legal-blackline comparison. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ originalDocumentTitle?: string; /** * Sets a password that must be supplied to open the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ password?: string; /** * Gets the algorithm used for password encryption. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ passwordEncryptionAlgorithm?: string; /** * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ passwordEncryptionKeyLength?: number; /** * Gets the name of the password encryption provider. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ passwordEncryptionProvider?: string; /** * Gets the disk or the web path to the document (excludes the document name). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ path?: string; /** * Specifies whether revision marks are printed with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ printRevisions?: boolean; /** * Gets the protection type for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ protectionType?: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"; /** * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutSizeX?: number; /** * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutSizeY?: number; /** * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingModeIsLayoutFrozen?: boolean; /** * Specifies whether Word removes user information upon saving. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ removePersonalInformationOnSave?: boolean; /** * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisedDocumentTitle?: string; /** * Specifies the encoding used when saving the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Gets the file format of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ saveFormat?: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"; /** @@ -158921,88 +155621,77 @@ declare namespace Word { * Specifies the encoding for saving as encoded text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Specifies how Word marks line and paragraph breaks in text files. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; /** * Specifies whether to track formatting changes when change tracking is on. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackFormatting?: boolean; /** * Specifies whether to mark moved text when Track Changes is on. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackMoves?: boolean; /** * Specifies whether changes are tracked in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackRevisions?: boolean; /** * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackedChangesAreDateAndTimeRemoved?: boolean; /** * Gets the document type (template or document). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.DocumentType | "Document" | "Template" | "Frameset"; /** * Sets a password for saving changes to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ writePassword?: string; /** * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlAreAdvancedErrorsShown?: boolean; /** * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlIsXsltUsedWhenSaving?: boolean; /** * Specifies the path and file name for the XSLT to apply when saving a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlSaveThroughXslt?: string; } @@ -159644,16 +156333,14 @@ declare namespace Word { * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ level?: number; /** * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: string; } @@ -159800,56 +156487,49 @@ declare namespace Word { * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isAutoUpdated?: boolean; /** * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLocked?: boolean; /** * Specifies if the linked picture is saved with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPictureSavedWithDocument?: boolean; /** * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sourceFullName?: string; /** * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sourceName?: string; /** * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sourcePath?: string; /** * Gets the link type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; } @@ -160009,8 +156689,7 @@ declare namespace Word { * Specifies the name of the list template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: string; /** @@ -160055,72 +156734,63 @@ declare namespace Word { * Specifies the class type for the specified OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ classType?: string; /** * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconIndex?: number; /** * Specifies the text displayed below the icon for the OLE object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconLabel?: string; /** * Specifies the program file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconName?: string; /** * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconPath?: string; /** * Gets whether the specified object is displayed as an icon. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDisplayedAsIcon?: boolean; /** * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormattingPreservedOnUpdate?: boolean; /** * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ label?: string; /** * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ progId?: string; } @@ -160186,258 +156856,227 @@ declare namespace Word { * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ next?: Word.Interfaces.WindowData; /** * Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previous?: Word.Interfaces.WindowData; /** * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areRulersDisplayed?: boolean; /** * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areScreenTipsDisplayed?: boolean; /** * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areThumbnailsDisplayed?: boolean; /** * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ caption?: string; /** * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ height?: number; /** * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalPercentScrolled?: number; /** * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** * Gets the position of an item in a collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ index?: number; /** * Specifies whether the window is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isActive?: boolean; /** * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDocumentMapVisible?: boolean; /** * Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEnvelopeVisible?: boolean; /** * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isHorizontalScrollBarDisplayed?: boolean; /** * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLeftScrollBarDisplayed?: boolean; /** * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isRightRulerDisplayed?: boolean; /** * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSplit?: boolean; /** * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVerticalRulerDisplayed?: boolean; /** * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVerticalScrollBarDisplayed?: boolean; /** * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVisible?: boolean; /** * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ left?: number; /** * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ splitVertical?: number; /** - * Specifies the width of the style area in points. + * Specifies the state of the document window or task window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ + state?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + /** + * Specifies the width of the style area in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ styleAreaWidth?: number; /** * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ top?: number; /** * Gets the window type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.WindowType | "Document" | "Template"; /** * Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ usableHeight?: number; /** * Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ usableWidth?: number; /** * Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ verticalPercentScrolled?: number; /** * Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ width?: number; /** * Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ windowNumber?: number; - /** - * Specifies the state of the document window or task window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; } /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ interface WindowCollectionData { @@ -160734,16 +157373,14 @@ declare namespace Word { * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ borders?: Word.Interfaces.BorderUniversalData[]; /** * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ conflicts?: Word.Interfaces.ConflictData[]; /** @@ -160829,80 +157466,70 @@ declare namespace Word { * Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bold?: boolean; /** * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ boldBidirectional?: boolean; /** * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** * Specifies the character width of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** * Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ combineCharacters?: boolean; /** * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ disableCharacterSpaceGrid?: boolean; /** * Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** * Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: number; /** * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitTextWidth?: number; /** * Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grammarChecked?: boolean; /** @@ -160916,16 +157543,14 @@ declare namespace Word { * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ highlightColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** * Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** @@ -160939,8 +157564,7 @@ declare namespace Word { * Specifies the ID for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id?: string; /** @@ -160954,40 +157578,35 @@ declare namespace Word { * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEndOfRowMark?: boolean; /** * Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isTextVisibleOnScreen?: boolean; /** * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ italic?: boolean; /** * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ italicBidirectional?: boolean; /** * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ kana?: Word.Kana | "Katakana" | "Hiragana"; /** @@ -161022,40 +157641,35 @@ declare namespace Word { * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showAll?: boolean; /** * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spellingChecked?: boolean; /** * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: number; /** * Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyLength?: number; /** * Gets the story type for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** @@ -161083,8 +157697,7 @@ declare namespace Word { * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; /** @@ -161094,7 +157707,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underline?: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; } /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ interface RangeCollectionData { @@ -161512,8 +158125,7 @@ declare namespace Word { * Specifies the description of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ description?: string; /** @@ -161611,8 +158223,7 @@ declare namespace Word { * Specifies the title of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ title?: string; /** @@ -161671,16 +158282,14 @@ declare namespace Word { * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columnStripe?: number; /** * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isBreakAcrossPagesAllowed?: boolean; /** @@ -161694,8 +158303,7 @@ declare namespace Word { * Specifies the left indent value (in points) for the rows in the table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftIndent?: number; /** @@ -161709,16 +158317,14 @@ declare namespace Word { * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rowStripe?: number; /** * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** @@ -161735,32 +158341,28 @@ declare namespace Word { * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** * Gets whether this tab stop is a custom tab stop. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ customTab?: boolean; /** * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ position?: number; } @@ -161849,8 +158451,7 @@ declare namespace Word { * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bookmark?: string; /** @@ -161858,80 +158459,70 @@ declare namespace Word { 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ category?: number; /** * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entrySeparator?: string; /** * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isCategoryHeaderIncluded?: boolean; /** * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEntryFormattingKept?: boolean; /** * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPassimUsed?: boolean; /** * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageNumberSeparator?: string; /** * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageRangeSeparator?: string; /** * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceName?: string; /** * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceSeparator?: string; /** * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; } @@ -161946,8 +158537,7 @@ declare namespace Word { Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: string; } @@ -161961,80 +158551,70 @@ declare namespace Word { * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBuiltInHeadingStylesUsed?: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldsUsed?: boolean; /** * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areHyperlinksUsedOnWeb?: boolean; /** * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersHiddenOnWeb?: boolean; /** * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersIncluded?: boolean; /** * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersRightAligned?: boolean; /** * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel?: number; /** * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: string; /** * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel?: number; } @@ -162048,96 +158628,84 @@ declare namespace Word { * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBuiltInHeadingStylesUsed?: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldsUsed?: boolean; /** * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areHyperlinksUsedOnWeb?: boolean; /** * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersHiddenOnWeb?: boolean; /** * Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersIncluded?: boolean; /** * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersRightAligned?: boolean; /** * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ captionLabel?: string; /** * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLabelIncluded?: boolean; /** * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel?: number; /** * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: string; /** * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel?: number; } @@ -162469,408 +159037,357 @@ declare namespace Word { * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areAllNonprintingCharactersDisplayed?: boolean; /** * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBackgroundsDisplayed?: boolean; /** * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBookmarksIndicated?: boolean; /** * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areCommentsDisplayed?: boolean; /** * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areCropMarksDisplayed?: boolean; /** * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areDrawingsDisplayed?: boolean; /** * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areEditableRangesShaded?: boolean; /** * Specifies whether field codes are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldCodesDisplayed?: boolean; /** * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFormatChangesDisplayed?: boolean; /** * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areInkAnnotationsDisplayed?: boolean; /** * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areInsertionsAndDeletionsDisplayed?: boolean; /** * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areLinesWrappedToWindow?: boolean; /** * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areObjectAnchorsDisplayed?: boolean; /** * Gets whether Microsoft Word displays optional line breaks. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areOptionalBreaksDisplayed?: boolean; /** * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areOptionalHyphensDisplayed?: boolean; /** * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areOtherAuthorsVisible?: boolean; /** * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageBoundariesDisplayed?: boolean; /** * Gets whether paragraph marks are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areParagraphsMarksDisplayed?: boolean; /** * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePicturePlaceholdersDisplayed?: boolean; /** * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areRevisionsAndCommentsDisplayed?: boolean; /** * Gets whether space characters are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areSpacesIndicated?: boolean; /** * Specifies whether table gridlines are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTableGridlinesDisplayed?: boolean; /** * Gets whether tab characters are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTabsDisplayed?: boolean; /** * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTextBoundariesDisplayed?: boolean; /** * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** * Gets on-screen shading for fields. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDraft?: boolean; /** * Specifies whether only the first line of body text is shown in outline view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFirstLineOnlyDisplayed?: boolean; /** * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormatDisplayed?: boolean; /** * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFullScreen?: boolean; /** * Gets whether text formatted as hidden text is displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isHiddenTextDisplayed?: boolean; /** * Gets whether highlight formatting is displayed and printed with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isHighlightingDisplayed?: boolean; /** * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInConflictMode?: boolean; /** * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInPanning?: boolean; /** * Specifies whether the document is being viewed in reading layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInReadingLayout?: boolean; /** * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMailMergeDataView?: boolean; /** * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMainTextLayerVisible?: boolean; /** * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPointerShownAsMagnifier?: boolean; /** * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isReadingLayoutActualView?: boolean; /** * Specifies whether XML tags are visible in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isXmlMarkupVisible?: boolean; /** * Specifies the display mode for tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** * Specifies the page movement type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; /** * Specifies the width of the revision balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsBalloonWidth?: number; /** * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** * Specifies the document element displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** * Specifies the active window pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** * Specifies the view type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; } @@ -163294,8 +159811,7 @@ declare namespace Word { * Specifies if the `Reviewer` object is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVisible?: boolean; } @@ -163309,16 +159825,14 @@ declare namespace Word { * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ view?: Word.RevisionsView | "Final" | "Original"; } @@ -163338,56 +159852,49 @@ declare namespace Word { * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ movedRange?: Word.Interfaces.RangeData; /** * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeData; /** * Gets the name of the user who made the tracked change. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ author?: string; /** * Gets the date and time when the tracked change was made. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ date?: Date; /** * Gets the description of tracked formatting changes in the revision. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formatDescription?: string; /** * Gets a number that represents the position of this item in a collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ index?: number; /** * Gets the revision type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; } @@ -163836,7 +160343,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingData; + xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * @@ -163928,16 +160435,14 @@ declare namespace Word { * Returns the name of the readability statistic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: string; /** * Returns the value of the grammar statistic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ value?: number; } @@ -163951,80 +160456,70 @@ declare namespace Word { * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ allowPng?: boolean; /** * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ encoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ folderSuffix?: string; /** * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ organizeInFolder?: boolean; /** * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pixelsPerInch?: number; /** * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ relyOnCSS?: boolean; /** * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ relyOnVectorMarkupLanguage?: boolean; /** * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ screenSize?: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** * Specifies the target browser for documents viewed in a web browser. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ targetBrowser?: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useLongFileNames?: boolean; } @@ -164038,82 +160533,74 @@ declare namespace Word { * Gets the name of the element without any prefix. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ baseName?: string; /** * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hasChildNodes?: boolean; /** * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ level?: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ namespaceUri?: string; /** - * Gets the type of node. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - nodeType?: Word.XmlNodeType | "Element" | "Attribute"; + placeholderText?: string; /** - * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - nodeValue?: string; + text?: string; /** - * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. + * Gets the type of node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: string; + type?: Word.XmlNodeType | "Element" | "Attribute"; /** - * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - text?: string; + validationErrorText?: string; /** - * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - validationErrorText?: string; + validationStatus?: Word.XmlValidationStatus | "Ok" | "Custom"; /** - * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - validationStatus?: Word.XmlValidationStatus | "Ok" | "Custom"; + value?: string; } /** An interface describing the data returned by calling `htmlDivision.toJSON()`. */ interface HtmlDivisionData { @@ -164121,32 +160608,28 @@ declare namespace Word { * Specifies the left indent value (in points) for this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftIndent?: number; /** * Specifies the right indent (in points) for this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightIndent?: number; /** * Specifies the amount of spacing (in points) after this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaceAfter?: number; /** * Specifies the spacing (in points) before this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaceBefore?: number; } @@ -164300,32 +160783,28 @@ declare namespace Word { * Gets the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ distanceFromText?: number; /** * Gets the name of the font for the dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fontName?: string; /** * Gets the height (in lines) of the dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ linesToDrop?: number; /** * Gets the position of the dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ position?: Word.DropPosition | "None" | "Normal" | "Margin"; } @@ -165356,16 +161835,14 @@ declare namespace Word { * Specifies the ending character position of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: number; /** * Specifies the width in which Word fits the text in the current selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitTextWidth?: number; /** @@ -165373,136 +161850,119 @@ declare namespace Word { If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hasNoProofing?: boolean; /** * Returns whether the selection in the specified window or pane is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isActive?: boolean; /** * Specifies whether column selection mode is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isColumnSelectModeActive?: boolean; /** * Returns whether the selection is at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEndOfRowMark?: boolean; /** * Specifies whether Extend mode is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isExtendModeActive?: boolean; /** * Returns whether the insertion point is at the end of a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInsertionPointAtEndOfLine?: boolean; /** * Specifies whether the beginning of the selection is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isStartActive?: boolean; /** * Specifies whether Word has detected the language of the selected text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageDetected?: boolean; /** * Returns the language for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** * Returns the East Asian language for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** * Specifies the orientation of text in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** * Specifies the starting character position of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: number; /** * Returns the number of characters in the story that contains the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyLength?: number; /** * Returns the story type for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** * Specifies the text in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ text?: string; /** * Returns the selection type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; } @@ -165516,56 +161976,49 @@ declare namespace Word { * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeData; /** * Specifies the ending character position of the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: number; /** * Returns `true` if the bookmark is a table column. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isColumn?: boolean; /** * Returns `true` if the bookmark is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEmpty?: boolean; /** * Returns the name of the `Bookmark` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: string; /** * Specifies the starting character position of the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: number; /** * Returns the story type for the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; } @@ -165579,8 +162032,7 @@ declare namespace Word { * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeData; /** @@ -165588,8 +162040,7 @@ declare namespace Word { See `IndexFilter` for available values. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; /** @@ -165597,32 +162048,28 @@ declare namespace Word { the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; /** * Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** * Gets the number of columns for each page of the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ numberOfColumns?: number; /** * Specifies if page numbers are aligned with the right margin in the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightAlignPageNumbers?: boolean; /** @@ -165630,32 +162077,28 @@ declare namespace Word { one heading and words that begin with "A" are under another). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ separateAccentedLetterHeadings?: boolean; /** * Specifies the sorting criteria for the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; /** * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * Gets the index type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: Word.IndexType | "Indent" | "Runin"; } @@ -165678,8 +162121,7 @@ declare namespace Word { * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface EditorLoadOptions { /** @@ -165690,32 +162132,28 @@ declare namespace Word { * Gets a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ nextRange?: Word.Interfaces.RangeLoadOptions; /** * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id?: boolean; /** * Gets the name of the editor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; } @@ -165723,8 +162161,7 @@ declare namespace Word { * Represents the coauthoring conflicts in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface ConflictCollectionLoadOptions { /** @@ -165735,16 +162172,14 @@ declare namespace Word { * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Gets the `RevisionType` for the `Conflict` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -165752,8 +162187,7 @@ declare namespace Word { * Represents a coauthoring conflict in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface ConflictLoadOptions { /** @@ -165764,16 +162198,14 @@ declare namespace Word { * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the `RevisionType` for the `Conflict` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -165914,7 +162346,7 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] @@ -166423,8 +162855,7 @@ declare namespace Word { * Represents a coauthoring lock in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface CoauthoringLockLoadOptions { /** @@ -166435,24 +162866,21 @@ declare namespace Word { * Gets the owner of the lock. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ owner?: Word.Interfaces.CoauthorLoadOptions; /** * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -166460,8 +162888,7 @@ declare namespace Word { * Represents a collection of coauthoring locks in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface CoauthoringLockCollectionLoadOptions { /** @@ -166472,24 +162899,21 @@ declare namespace Word { * For EACH ITEM in the collection: Gets the owner of the lock. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ owner?: Word.Interfaces.CoauthorLoadOptions; /** * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -166497,8 +162921,7 @@ declare namespace Word { * Represents a coauthor in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface CoauthorLoadOptions { /** @@ -166509,32 +162932,28 @@ declare namespace Word { * Gets the email address of the coauthor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ emailAddress?: boolean; /** * Gets the unique identifier for the `Coauthor` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id?: boolean; /** * Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMe?: boolean; /** * Gets the display name of the coauthor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; } @@ -166542,8 +162961,7 @@ declare namespace Word { * Contains a collection of {@link Word.Coauthor} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface CoauthorCollectionLoadOptions { /** @@ -166554,32 +162972,28 @@ declare namespace Word { * For EACH ITEM in the collection: Gets the email address of the coauthor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ emailAddress?: boolean; /** * For EACH ITEM in the collection: Gets the unique identifier for the `Coauthor` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id?: boolean; /** * For EACH ITEM in the collection: Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMe?: boolean; /** * For EACH ITEM in the collection: Gets the display name of the coauthor. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; } @@ -166587,8 +163001,7 @@ declare namespace Word { * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface CoauthoringLoadOptions { /** @@ -166599,32 +163012,28 @@ declare namespace Word { * Gets a `Coauthor` object that represents the current user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ me?: Word.Interfaces.CoauthorLoadOptions; /** * Gets whether this document can be coauthored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ canCoauthor?: boolean; /** * Gets whether the document can be automatically merged. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ canMerge?: boolean; /** * Gets whether the document has pending updates that have not been accepted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pendingUpdates?: boolean; } @@ -166632,8 +163041,7 @@ declare namespace Word { * Represents a coauthoring update in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface CoauthoringUpdateLoadOptions { /** @@ -166644,8 +163052,7 @@ declare namespace Word { * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; } @@ -166653,8 +163060,7 @@ declare namespace Word { * Contains a collection of {@link Word.CoauthoringUpdate} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface CoauthoringUpdateCollectionLoadOptions { /** @@ -166665,8 +163071,7 @@ declare namespace Word { * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; } @@ -166977,8 +163382,7 @@ declare namespace Word { * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface ConditionalStyleLoadOptions { /** @@ -166989,56 +163393,49 @@ declare namespace Word { * Returns a `Font` object that represents the font formatting for the conditional style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ font?: Word.Interfaces.FontLoadOptions; /** * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** * Returns a `ShadingUniversal` object that represents the shading of the conditional style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bottomPadding?: boolean; /** * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftPadding?: boolean; /** * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightPadding?: boolean; /** * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ topPadding?: boolean; } @@ -168237,8 +164634,7 @@ declare namespace Word { * Gets a `Shape` object that represents the background image for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ background?: Word.Interfaces.ShapeLoadOptions; /** @@ -168259,32 +164655,28 @@ declare namespace Word { * Gets a `DocumentProperties` object that represents all the built-in document properties for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ builtInDocumentProperties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ coauthoring?: Word.Interfaces.CoauthoringLoadOptions; /** * Gets a `Range` object that represents the main document story. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ content?: Word.Interfaces.RangeLoadOptions; /** * Gets a `DocumentProperties` collection that represents all the custom document properties for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ customDocumentProperties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** @@ -168305,88 +164697,77 @@ declare namespace Word { * Returns a `Selection` object that represents the current selection in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selection?: Word.Interfaces.SelectionLoadOptions; /** * Gets the `WebSettings` object for webpage-related attributes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ webSettings?: Word.Interfaces.WebSettingsLoadOptions; /** * Gets the name of the active theme and formatting options. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ activeTheme?: boolean; /** * Gets the display name of the active theme. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ activeThemeDisplayName?: boolean; /** * Gets whether Word encrypts file properties for password-protected documents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFilePropertiesPasswordEncrypted?: boolean; /** * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areGrammaticalErrorsShown?: boolean; /** * Specifies whether to use the default math settings when creating new equations. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areMathDefaultsUsed?: boolean; /** * Specifies whether to disable features introduced after a specified version. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areNewerFeaturesDisabled?: boolean; /** * Specifies whether Microsoft Word underlines spelling errors in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areSpellingErrorsShown?: boolean; /** * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areStylesUpdatedOnOpen?: boolean; /** * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTrueTypeFontsEmbedded?: boolean; /** @@ -168414,16 +164795,14 @@ declare namespace Word { * Gets the code name for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ codeName?: boolean; /** * Gets the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ compatibilityMode?: boolean; /** @@ -168437,152 +164816,133 @@ declare namespace Word { * Gets a random number that Word assigns to changes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ currentRsid?: boolean; /** * Specifies the interval (in points) between the default tab stops in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ defaultTabStop?: boolean; /** * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ defaultTargetFrame?: boolean; /** * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ doNotEmbedSystemFonts?: boolean; /** * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ encryptionProvider?: boolean; /** * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ farEastLineBreakLanguage?: boolean; /** * Specifies the line break control level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ farEastLineBreakLevel?: boolean; /** * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formattingIsNextLevelShown?: boolean; /** * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formattingIsUserStyleNameShown?: boolean; /** * Gets the name of a document, including the path. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fullName?: boolean; /** * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridDistanceHorizontal?: boolean; /** * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridDistanceVertical?: boolean; /** * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridIsOriginFromMargin?: boolean; /** * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridOriginHorizontal?: boolean; /** * Specifies the vertical origin point for the invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridOriginVertical?: boolean; /** * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridSpaceBetweenHorizontalLines?: boolean; /** * Specifies the interval for vertical character gridlines in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ gridSpaceBetweenVerticalLines?: boolean; /** * Gets whether a password is required to open the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hasPassword?: boolean; /** * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hasVbProject?: boolean; /** @@ -168596,240 +164956,210 @@ declare namespace Word { * Specifies the width of the hyphenation zone, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hyphenationZone?: boolean; /** * Specifies whether automatic formatting options override formatting restrictions. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isAutoFormatOverrideOn?: boolean; /** * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isChartDataPointTracked?: boolean; /** * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isCompatible?: boolean; /** * Specifies whether the document is final. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFinal?: boolean; /** * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFontsSubsetSaved?: boolean; /** * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormsDataPrinted?: boolean; /** * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormsDataSaved?: boolean; /** * Specifies whether a grammar check has been run on the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isGrammarChecked?: boolean; /** * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInAutoSave?: boolean; /** * Gets whether the document is in form design mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInFormsDesign?: boolean; /** * Specifies whether Word kerns half-width Latin characters and punctuation marks. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isKerningByAlgorithm?: boolean; /** * Specifies whether to embed speech and handwriting data. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLinguisticDataEmbedded?: boolean; /** * Gets whether this document is a master document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMasterDocument?: boolean; /** * Specifies whether Word optimizes the document for Word 97. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isOptimizedForWord97?: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPostScriptPrintedOverText?: boolean; /** * Specifies whether users can change the Quick Style set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isQuickStyleSetLocked?: boolean; /** * Gets whether changes to the document cannot be saved to the original document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isReadOnly?: boolean; /** * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isReadOnlyRecommended?: boolean; /** * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSnappedToGrid?: boolean; /** * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSnappedToShapes?: boolean; /** * Specifies whether spelling has been checked throughout the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSpellingChecked?: boolean; /** * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isStyleEnforced?: boolean; /** * Gets whether this document is a subdocument of a master document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSubdocument?: boolean; /** * Specifies whether users can change the document theme. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isThemeLocked?: boolean; /** * Specifies whether the document was created or opened by the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isUserControl?: boolean; /** * Gets whether the VBA project is digitally signed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVbaSigned?: boolean; /** * Gets whether the document is protected with a write password. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isWriteReserved?: boolean; /** * Specifies the character spacing adjustment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ justificationMode?: boolean; /** * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ kind?: boolean; /** @@ -168843,144 +165173,126 @@ declare namespace Word { * Specifies the kinsoku characters after which Word will not break a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noLineBreakAfter?: boolean; /** * Specifies the kinsoku characters before which Word will not break a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ noLineBreakBefore?: boolean; /** * Gets the encoding used to open the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ openEncoding?: boolean; /** * Gets the title of the original document after legal-blackline comparison. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ originalDocumentTitle?: boolean; /** * Sets a password that must be supplied to open the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ password?: boolean; /** * Gets the algorithm used for password encryption. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ passwordEncryptionAlgorithm?: boolean; /** * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ passwordEncryptionKeyLength?: boolean; /** * Gets the name of the password encryption provider. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ passwordEncryptionProvider?: boolean; /** * Gets the disk or the web path to the document (excludes the document name). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ path?: boolean; /** * Specifies whether revision marks are printed with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ printRevisions?: boolean; /** * Gets the protection type for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ protectionType?: boolean; /** * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutSizeX?: boolean; /** * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutSizeY?: boolean; /** * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingModeIsLayoutFrozen?: boolean; /** * Specifies whether Word removes user information upon saving. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ removePersonalInformationOnSave?: boolean; /** * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisedDocumentTitle?: boolean; /** * Specifies the encoding used when saving the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ saveEncoding?: boolean; /** * Gets the file format of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ saveFormat?: boolean; /** @@ -168994,88 +165306,77 @@ declare namespace Word { * Specifies the encoding for saving as encoded text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ textEncoding?: boolean; /** * Specifies how Word marks line and paragraph breaks in text files. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ textLineEnding?: boolean; /** * Specifies whether to track formatting changes when change tracking is on. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackFormatting?: boolean; /** * Specifies whether to mark moved text when Track Changes is on. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackMoves?: boolean; /** * Specifies whether changes are tracked in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackRevisions?: boolean; /** * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ trackedChangesAreDateAndTimeRemoved?: boolean; /** * Gets the document type (template or document). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; /** * Sets a password for saving changes to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ writePassword?: boolean; /** * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlAreAdvancedErrorsShown?: boolean; /** * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlIsXsltUsedWhenSaving?: boolean; /** * Specifies the path and file name for the XSLT to apply when saving a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ xmlSaveThroughXslt?: boolean; } @@ -169262,16 +165563,14 @@ declare namespace Word { * Gets a `LinkFormat` object that represents the link options of the field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** @@ -169394,16 +165693,14 @@ declare namespace Word { * For EACH ITEM in the collection: Gets a `LinkFormat` object that represents the link options of the field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** * For EACH ITEM in the collection: Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** @@ -169900,8 +166197,7 @@ declare namespace Word { * Represents a heading style used in a table of contents or table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface HeadingStyleLoadOptions { /** @@ -169912,16 +166208,14 @@ declare namespace Word { * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ level?: boolean; /** * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; } @@ -169929,8 +166223,7 @@ declare namespace Word { * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface HeadingStyleCollectionLoadOptions { /** @@ -169941,16 +166234,14 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ level?: boolean; /** * For EACH ITEM in the collection: Specifies the name of style for a heading. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; } @@ -170342,8 +166633,7 @@ declare namespace Word { * Represents the linking characteristics for an OLE object or picture. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface LinkFormatLoadOptions { /** @@ -170354,56 +166644,49 @@ declare namespace Word { * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isAutoUpdated?: boolean; /** * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLocked?: boolean; /** * Specifies if the linked picture is saved with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPictureSavedWithDocument?: boolean; /** * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sourceFullName?: boolean; /** * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sourceName?: boolean; /** * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sourcePath?: boolean; /** * Gets the link type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -170699,8 +166982,7 @@ declare namespace Word { * Specifies the name of the list template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; /** @@ -170781,8 +167063,7 @@ declare namespace Word { * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface OleFormatLoadOptions { /** @@ -170793,72 +167074,63 @@ declare namespace Word { * Specifies the class type for the specified OLE object, picture, or field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ classType?: boolean; /** * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconIndex?: boolean; /** * Specifies the text displayed below the icon for the OLE object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconLabel?: boolean; /** * Specifies the program file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconName?: boolean; /** * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ iconPath?: boolean; /** * Gets whether the specified object is displayed as an icon. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDisplayedAsIcon?: boolean; /** * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormattingPreservedOnUpdate?: boolean; /** * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ label?: boolean; /** * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ progId?: boolean; } @@ -170943,8 +167215,7 @@ declare namespace Word { * Returns a `Selection` object that represents the current selection in the pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selection?: Word.Interfaces.SelectionLoadOptions; } @@ -170963,8 +167234,7 @@ declare namespace Word { * For EACH ITEM in the collection: Returns a `Selection` object that represents the current selection in the pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ selection?: Word.Interfaces.SelectionLoadOptions; } @@ -170990,266 +167260,234 @@ declare namespace Word { * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ next?: Word.Interfaces.WindowLoadOptions; /** * Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previous?: Word.Interfaces.WindowLoadOptions; /** * Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ view?: Word.Interfaces.ViewLoadOptions; /** * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areRulersDisplayed?: boolean; /** * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areScreenTipsDisplayed?: boolean; /** * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areThumbnailsDisplayed?: boolean; /** * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ caption?: boolean; /** * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ height?: boolean; /** * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalPercentScrolled?: boolean; /** * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ imeMode?: boolean; /** * Gets the position of an item in a collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ index?: boolean; /** * Specifies whether the window is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isActive?: boolean; /** * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDocumentMapVisible?: boolean; /** * Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEnvelopeVisible?: boolean; /** * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isHorizontalScrollBarDisplayed?: boolean; /** * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLeftScrollBarDisplayed?: boolean; /** * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isRightRulerDisplayed?: boolean; /** * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSplit?: boolean; /** * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVerticalRulerDisplayed?: boolean; /** * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVerticalScrollBarDisplayed?: boolean; /** * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVisible?: boolean; /** * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ left?: boolean; /** * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showSourceDocuments?: boolean; /** * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ splitVertical?: boolean; /** - * Specifies the width of the style area in points. + * Specifies the state of the document window or task window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ + state?: boolean; + /** + * Specifies the width of the style area in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ styleAreaWidth?: boolean; /** * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ top?: boolean; /** * Gets the window type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; /** * Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ usableHeight?: boolean; /** * Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ usableWidth?: boolean; /** * Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ verticalPercentScrolled?: boolean; /** * Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ width?: boolean; /** * Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ windowNumber?: boolean; - /** - * Specifies the state of the document window or task window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - windowState?: boolean; } /** * Represents the collection of {@link Word.Window} objects. @@ -171273,266 +167511,234 @@ declare namespace Word { * For EACH ITEM in the collection: Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ next?: Word.Interfaces.WindowLoadOptions; /** * For EACH ITEM in the collection: Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previous?: Word.Interfaces.WindowLoadOptions; /** * For EACH ITEM in the collection: Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ view?: Word.Interfaces.ViewLoadOptions; /** * For EACH ITEM in the collection: Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areRulersDisplayed?: boolean; /** * For EACH ITEM in the collection: Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areScreenTipsDisplayed?: boolean; /** * For EACH ITEM in the collection: Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areThumbnailsDisplayed?: boolean; /** * For EACH ITEM in the collection: Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ caption?: boolean; /** * For EACH ITEM in the collection: Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ height?: boolean; /** * For EACH ITEM in the collection: Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalPercentScrolled?: boolean; /** * For EACH ITEM in the collection: Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ imeMode?: boolean; /** * For EACH ITEM in the collection: Gets the position of an item in a collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ index?: boolean; /** * For EACH ITEM in the collection: Specifies whether the window is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isActive?: boolean; /** * For EACH ITEM in the collection: Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDocumentMapVisible?: boolean; /** * For EACH ITEM in the collection: Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEnvelopeVisible?: boolean; /** * For EACH ITEM in the collection: Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isHorizontalScrollBarDisplayed?: boolean; /** * For EACH ITEM in the collection: Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLeftScrollBarDisplayed?: boolean; /** * For EACH ITEM in the collection: Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isRightRulerDisplayed?: boolean; /** * For EACH ITEM in the collection: Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isSplit?: boolean; /** * For EACH ITEM in the collection: Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVerticalRulerDisplayed?: boolean; /** * For EACH ITEM in the collection: Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVerticalScrollBarDisplayed?: boolean; /** * For EACH ITEM in the collection: Specifies whether the window is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVisible?: boolean; /** * For EACH ITEM in the collection: Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ left?: boolean; /** * For EACH ITEM in the collection: Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showSourceDocuments?: boolean; /** * For EACH ITEM in the collection: Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ splitVertical?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the style area in points. + * For EACH ITEM in the collection: Specifies the state of the document window or task window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ + state?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width of the style area in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ styleAreaWidth?: boolean; /** * For EACH ITEM in the collection: Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ top?: boolean; /** * For EACH ITEM in the collection: Gets the window type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; /** * For EACH ITEM in the collection: Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ usableHeight?: boolean; /** * For EACH ITEM in the collection: Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ usableWidth?: boolean; /** * For EACH ITEM in the collection: Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ verticalPercentScrolled?: boolean; /** * For EACH ITEM in the collection: Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ width?: boolean; /** * For EACH ITEM in the collection: Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ windowNumber?: boolean; - /** - * For EACH ITEM in the collection: Specifies the state of the document window or task window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - windowState?: boolean; } /** * Represents a single paragraph in a selection, range, content control, or document body. @@ -172173,80 +168379,70 @@ declare namespace Word { * Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bold?: boolean; /** * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ boldBidirectional?: boolean; /** * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ case?: boolean; /** * Specifies the character width of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ characterWidth?: boolean; /** * Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ combineCharacters?: boolean; /** * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ disableCharacterSpaceGrid?: boolean; /** * Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ emphasisMark?: boolean; /** * Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: boolean; /** * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitTextWidth?: boolean; /** * Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grammarChecked?: boolean; /** @@ -172260,16 +168456,14 @@ declare namespace Word { * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ highlightColorIndex?: boolean; /** * Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalInVertical?: boolean; /** @@ -172283,8 +168477,7 @@ declare namespace Word { * Specifies the ID for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id?: boolean; /** @@ -172298,40 +168491,35 @@ declare namespace Word { * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEndOfRowMark?: boolean; /** * Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isTextVisibleOnScreen?: boolean; /** * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ italic?: boolean; /** * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ italicBidirectional?: boolean; /** * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ kana?: boolean; /** @@ -172366,40 +168554,35 @@ declare namespace Word { * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showAll?: boolean; /** * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spellingChecked?: boolean; /** * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: boolean; /** * Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyLength?: boolean; /** * Gets the story type for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyType?: boolean; /** @@ -172427,8 +168610,7 @@ declare namespace Word { * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ twoLinesInOne?: boolean; /** @@ -172525,80 +168707,70 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bold?: boolean; /** * For EACH ITEM in the collection: Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ boldBidirectional?: boolean; /** * For EACH ITEM in the collection: Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ case?: boolean; /** * For EACH ITEM in the collection: Specifies the character width of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ characterWidth?: boolean; /** * For EACH ITEM in the collection: Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ combineCharacters?: boolean; /** * For EACH ITEM in the collection: Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ disableCharacterSpaceGrid?: boolean; /** * For EACH ITEM in the collection: Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ emphasisMark?: boolean; /** * For EACH ITEM in the collection: Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: boolean; /** * For EACH ITEM in the collection: Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitTextWidth?: boolean; /** * For EACH ITEM in the collection: Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grammarChecked?: boolean; /** @@ -172612,16 +168784,14 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ highlightColorIndex?: boolean; /** * For EACH ITEM in the collection: Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalInVertical?: boolean; /** @@ -172635,8 +168805,7 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies the ID for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id?: boolean; /** @@ -172650,40 +168819,35 @@ declare namespace Word { * For EACH ITEM in the collection: Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEndOfRowMark?: boolean; /** * For EACH ITEM in the collection: Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isTextVisibleOnScreen?: boolean; /** * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ italic?: boolean; /** * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ italicBidirectional?: boolean; /** * For EACH ITEM in the collection: Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ kana?: boolean; /** @@ -172718,40 +168882,35 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showAll?: boolean; /** * For EACH ITEM in the collection: Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spellingChecked?: boolean; /** * For EACH ITEM in the collection: Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: boolean; /** * For EACH ITEM in the collection: Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyLength?: boolean; /** * For EACH ITEM in the collection: Gets the story type for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyType?: boolean; /** @@ -172779,8 +168938,7 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ twoLinesInOne?: boolean; /** @@ -173535,8 +169693,7 @@ declare namespace Word { * Returns the `ShadingUniversal` object that represents the shading of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** @@ -173550,8 +169707,7 @@ declare namespace Word { * Specifies the description of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ description?: boolean; /** @@ -173649,8 +169805,7 @@ declare namespace Word { * Specifies the title of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ title?: boolean; /** @@ -173690,8 +169845,7 @@ declare namespace Word { * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingLoadOptions; /** @@ -173726,16 +169880,14 @@ declare namespace Word { * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columnStripe?: boolean; /** * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isBreakAcrossPagesAllowed?: boolean; /** @@ -173749,8 +169901,7 @@ declare namespace Word { * Specifies the left indent value (in points) for the rows in the table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftIndent?: boolean; /** @@ -173764,16 +169915,14 @@ declare namespace Word { * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rowStripe?: boolean; /** * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableDirection?: boolean; /** @@ -173788,8 +169937,7 @@ declare namespace Word { * Represents a tab stop in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TabStopLoadOptions { /** @@ -173800,48 +169948,42 @@ declare namespace Word { * Gets the next tab stop in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ next?: Word.Interfaces.TabStopLoadOptions; /** * Gets the previous tab stop in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previous?: Word.Interfaces.TabStopLoadOptions; /** * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ alignment?: boolean; /** * Gets whether this tab stop is a custom tab stop. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ customTab?: boolean; /** * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leader?: boolean; /** * Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ position?: boolean; } @@ -173849,8 +169991,7 @@ declare namespace Word { * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TabStopCollectionLoadOptions { /** @@ -173861,48 +170002,42 @@ declare namespace Word { * For EACH ITEM in the collection: Gets the next tab stop in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ next?: Word.Interfaces.TabStopLoadOptions; /** * For EACH ITEM in the collection: Gets the previous tab stop in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previous?: Word.Interfaces.TabStopLoadOptions; /** * For EACH ITEM in the collection: Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ alignment?: boolean; /** * For EACH ITEM in the collection: Gets whether this tab stop is a custom tab stop. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ customTab?: boolean; /** * For EACH ITEM in the collection: Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leader?: boolean; /** * For EACH ITEM in the collection: Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ position?: boolean; } @@ -173977,8 +170112,7 @@ declare namespace Word { * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** @@ -173992,8 +170126,7 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies the description of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ description?: boolean; /** @@ -174091,8 +170224,7 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies the title of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ title?: boolean; /** @@ -174259,8 +170391,7 @@ declare namespace Word { * Represents a table of authorities in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfAuthoritiesLoadOptions { /** @@ -174271,16 +170402,14 @@ declare namespace Word { * Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bookmark?: boolean; /** @@ -174288,80 +170417,70 @@ declare namespace Word { 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ category?: boolean; /** * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entrySeparator?: boolean; /** * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isCategoryHeaderIncluded?: boolean; /** * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEntryFormattingKept?: boolean; /** * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPassimUsed?: boolean; /** * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageNumberSeparator?: boolean; /** * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageRangeSeparator?: boolean; /** * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceName?: boolean; /** * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceSeparator?: boolean; /** * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: boolean; } @@ -174369,8 +170488,7 @@ declare namespace Word { * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfAuthoritiesCollectionLoadOptions { /** @@ -174381,16 +170499,14 @@ declare namespace Word { * For EACH ITEM in the collection: Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bookmark?: boolean; /** @@ -174398,80 +170514,70 @@ declare namespace Word { 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ category?: boolean; /** * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ entrySeparator?: boolean; /** * For EACH ITEM in the collection: Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isCategoryHeaderIncluded?: boolean; /** * For EACH ITEM in the collection: Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEntryFormattingKept?: boolean; /** * 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". * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPassimUsed?: boolean; /** * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageNumberSeparator?: boolean; /** * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageRangeSeparator?: boolean; /** * For EACH ITEM in the collection: Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceName?: boolean; /** * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sequenceSeparator?: boolean; /** * For EACH ITEM in the collection: Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: boolean; } @@ -174479,8 +170585,7 @@ declare namespace Word { * Represents a category used in a table of authorities. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfAuthoritiesCategoryLoadOptions { /** @@ -174492,8 +170597,7 @@ declare namespace Word { Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; } @@ -174501,8 +170605,7 @@ declare namespace Word { * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfAuthoritiesCategoryCollectionLoadOptions { /** @@ -174514,8 +170617,7 @@ declare namespace Word { Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; } @@ -174523,8 +170625,7 @@ declare namespace Word { * Represents a table of contents in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfContentsLoadOptions { /** @@ -174535,88 +170636,77 @@ declare namespace Word { * Gets the portion of a document that is this table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBuiltInHeadingStylesUsed?: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldsUsed?: boolean; /** * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areHyperlinksUsedOnWeb?: boolean; /** * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersHiddenOnWeb?: boolean; /** * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersIncluded?: boolean; /** * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersRightAligned?: boolean; /** * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel?: boolean; /** * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: boolean; /** * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: boolean; /** * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel?: boolean; } @@ -174624,8 +170714,7 @@ declare namespace Word { * Represents a collection of {@link Word.TableOfContents} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfContentsCollectionLoadOptions { /** @@ -174636,88 +170725,77 @@ declare namespace Word { * For EACH ITEM in the collection: Gets the portion of a document that is this table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBuiltInHeadingStylesUsed?: boolean; /** * For EACH ITEM in the collection: Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldsUsed?: boolean; /** * For EACH ITEM in the collection: Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areHyperlinksUsedOnWeb?: boolean; /** * For EACH ITEM in the collection: Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersHiddenOnWeb?: boolean; /** * For EACH ITEM in the collection: Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersIncluded?: boolean; /** * For EACH ITEM in the collection: Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersRightAligned?: boolean; /** * For EACH ITEM in the collection: Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel?: boolean; /** * For EACH ITEM in the collection: Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: boolean; /** * For EACH ITEM in the collection: Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: boolean; /** * For EACH ITEM in the collection: Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel?: boolean; } @@ -174725,8 +170803,7 @@ declare namespace Word { * Represents a table of figures in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfFiguresLoadOptions { /** @@ -174737,104 +170814,91 @@ declare namespace Word { * Gets the portion of a document that is this table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBuiltInHeadingStylesUsed?: boolean; /** * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldsUsed?: boolean; /** * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areHyperlinksUsedOnWeb?: boolean; /** * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersHiddenOnWeb?: boolean; /** * Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersIncluded?: boolean; /** * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersRightAligned?: boolean; /** * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ captionLabel?: boolean; /** * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLabelIncluded?: boolean; /** * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel?: boolean; /** * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: boolean; /** * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: boolean; /** * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel?: boolean; } @@ -174842,8 +170906,7 @@ declare namespace Word { * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface TableOfFiguresCollectionLoadOptions { /** @@ -174854,104 +170917,91 @@ declare namespace Word { * For EACH ITEM in the collection: Gets the portion of a document that is this table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBuiltInHeadingStylesUsed?: boolean; /** * For EACH ITEM in the collection: Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldsUsed?: boolean; /** * For EACH ITEM in the collection: Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areHyperlinksUsedOnWeb?: boolean; /** * For EACH ITEM in the collection: Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersHiddenOnWeb?: boolean; /** * For EACH ITEM in the collection: Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersIncluded?: boolean; /** * For EACH ITEM in the collection: Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageNumbersRightAligned?: boolean; /** * For EACH ITEM in the collection: Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ captionLabel?: boolean; /** * For EACH ITEM in the collection: Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isLabelIncluded?: boolean; /** * For EACH ITEM in the collection: Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lowerHeadingLevel?: boolean; /** * For EACH ITEM in the collection: Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: boolean; /** * For EACH ITEM in the collection: Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tableId?: boolean; /** * For EACH ITEM in the collection: Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ upperHeadingLevel?: boolean; } @@ -174984,16 +171034,14 @@ declare namespace Word { * Returns the `Range` object that represents the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Returns the `ShadingUniversal` object that represents the shading of the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** @@ -175082,16 +171130,14 @@ declare namespace Word { * For EACH ITEM in the collection: Returns the `Range` object that represents the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** @@ -175173,8 +171219,7 @@ declare namespace Word { * Returns the `TableColumn` object that represents the table column that contains this cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ column?: Word.Interfaces.TableColumnLoadOptions; /** @@ -175195,8 +171240,7 @@ declare namespace Word { * Returns the `ShadingUniversal` object that represents the shading of the table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** @@ -175278,8 +171322,7 @@ declare namespace Word { * For EACH ITEM in the collection: Returns the `TableColumn` object that represents the table column that contains this cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ column?: Word.Interfaces.TableColumnLoadOptions; /** @@ -175300,8 +171343,7 @@ declare namespace Word { * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** @@ -175700,8 +171742,7 @@ declare namespace Word { * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface ViewLoadOptions { /** @@ -175712,416 +171753,364 @@ declare namespace Word { * Gets the instance of a `RevisionsFilter` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsFilter?: Word.Interfaces.RevisionsFilterLoadOptions; /** * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areAllNonprintingCharactersDisplayed?: boolean; /** * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBackgroundsDisplayed?: boolean; /** * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areBookmarksIndicated?: boolean; /** * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areCommentsDisplayed?: boolean; /** * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areCropMarksDisplayed?: boolean; /** * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areDrawingsDisplayed?: boolean; /** * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areEditableRangesShaded?: boolean; /** * Specifies whether field codes are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFieldCodesDisplayed?: boolean; /** * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areFormatChangesDisplayed?: boolean; /** * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areInkAnnotationsDisplayed?: boolean; /** * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areInsertionsAndDeletionsDisplayed?: boolean; /** * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areLinesWrappedToWindow?: boolean; /** * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areObjectAnchorsDisplayed?: boolean; /** * Gets whether Microsoft Word displays optional line breaks. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areOptionalBreaksDisplayed?: boolean; /** * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areOptionalHyphensDisplayed?: boolean; /** * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areOtherAuthorsVisible?: boolean; /** * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePageBoundariesDisplayed?: boolean; /** * Gets whether paragraph marks are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areParagraphsMarksDisplayed?: boolean; /** * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ arePicturePlaceholdersDisplayed?: boolean; /** * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areRevisionsAndCommentsDisplayed?: boolean; /** * Gets whether space characters are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areSpacesIndicated?: boolean; /** * Specifies whether table gridlines are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTableGridlinesDisplayed?: boolean; /** * Gets whether tab characters are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTabsDisplayed?: boolean; /** * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ areTextBoundariesDisplayed?: boolean; /** * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ columnWidth?: boolean; /** * Gets on-screen shading for fields. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fieldShading?: boolean; /** * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isDraft?: boolean; /** * Specifies whether only the first line of body text is shown in outline view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFirstLineOnlyDisplayed?: boolean; /** * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFormatDisplayed?: boolean; /** * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isFullScreen?: boolean; /** * Gets whether text formatted as hidden text is displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isHiddenTextDisplayed?: boolean; /** * Gets whether highlight formatting is displayed and printed with the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isHighlightingDisplayed?: boolean; /** * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInConflictMode?: boolean; /** * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInPanning?: boolean; /** * Specifies whether the document is being viewed in reading layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInReadingLayout?: boolean; /** * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMailMergeDataView?: boolean; /** * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isMainTextLayerVisible?: boolean; /** * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isPointerShownAsMagnifier?: boolean; /** * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isReadingLayoutActualView?: boolean; /** * Specifies whether XML tags are visible in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isXmlMarkupVisible?: boolean; /** * Specifies the display mode for tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ markupMode?: boolean; /** * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageColor?: boolean; /** * Specifies the page movement type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pageMovementType?: boolean; /** * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ readingLayoutTruncateMargins?: boolean; /** * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsBalloonSide?: boolean; /** * Specifies the width of the revision balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsBalloonWidth?: boolean; /** * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ revisionsBalloonWidthType?: boolean; /** * Specifies the document element displayed in print layout view. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ seekView?: boolean; /** * Specifies the active window pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ splitSpecial?: boolean; /** * Specifies the view type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -176801,8 +172790,7 @@ declare namespace Word { * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface ReviewerLoadOptions { /** @@ -176813,8 +172801,7 @@ declare namespace Word { * Specifies if the `Reviewer` object is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVisible?: boolean; } @@ -176822,8 +172809,7 @@ declare namespace Word { * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface ReviewerCollectionLoadOptions { /** @@ -176834,8 +172820,7 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies if the `Reviewer` object is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isVisible?: boolean; } @@ -176843,8 +172828,7 @@ declare namespace Word { * Represents the current settings related to the display of reviewers' comments and revision marks in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface RevisionsFilterLoadOptions { /** @@ -176855,16 +172839,14 @@ declare namespace Word { * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ markup?: boolean; /** * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ view?: boolean; } @@ -176891,8 +172873,7 @@ declare namespace Word { * Represents a single tracked change in a document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface RevisionLoadOptions { /** @@ -176903,56 +172884,49 @@ declare namespace Word { * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ movedRange?: Word.Interfaces.RangeLoadOptions; /** * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the name of the user who made the tracked change. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ author?: boolean; /** * Gets the date and time when the tracked change was made. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ date?: boolean; /** * Gets the description of tracked formatting changes in the revision. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formatDescription?: boolean; /** * Gets a number that represents the position of this item in a collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ index?: boolean; /** * Gets the revision type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -176960,8 +172934,7 @@ declare namespace Word { * A collection of {@link Word.Revision} objects that represent the changes marked with revision marks in a range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface RevisionCollectionLoadOptions { /** @@ -176972,56 +172945,49 @@ declare namespace Word { * For EACH ITEM in the collection: Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ movedRange?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Gets the name of the user who made the tracked change. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ author?: boolean; /** * For EACH ITEM in the collection: Gets the date and time when the tracked change was made. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ date?: boolean; /** * For EACH ITEM in the collection: Gets the description of tracked formatting changes in the revision. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formatDescription?: boolean; /** * For EACH ITEM in the collection: Gets a number that represents the position of this item in a collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ index?: boolean; /** * For EACH ITEM in the collection: Gets the revision type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -177511,7 +173477,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingLoadOptions; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * @@ -177601,8 +173567,7 @@ declare namespace Word { * Represents one of the readability statistics for the document or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface ReadabilityStatisticLoadOptions { /** @@ -177613,16 +173578,14 @@ declare namespace Word { * Returns the name of the readability statistic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; /** * Returns the value of the grammar statistic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ value?: boolean; } @@ -177630,8 +173593,7 @@ declare namespace Word { * Represents a collection of {@link Word.ReadabilityStatistic} objects for the document or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface ReadabilityStatisticCollectionLoadOptions { /** @@ -177642,16 +173604,14 @@ declare namespace Word { * For EACH ITEM in the collection: Returns the name of the readability statistic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; /** * For EACH ITEM in the collection: Returns the value of the grammar statistic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ value?: boolean; } @@ -177659,8 +173619,7 @@ declare namespace Word { * Represents the settings for saving a Word document as a webpage. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface WebSettingsLoadOptions { /** @@ -177671,80 +173630,70 @@ declare namespace Word { * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ allowPng?: boolean; /** * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ encoding?: boolean; /** * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ folderSuffix?: boolean; /** * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ organizeInFolder?: boolean; /** * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ pixelsPerInch?: boolean; /** * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ relyOnCSS?: boolean; /** * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ relyOnVectorMarkupLanguage?: boolean; /** * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ screenSize?: boolean; /** * Specifies the target browser for documents viewed in a web browser. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ targetBrowser?: boolean; /** * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ useLongFileNames?: boolean; } @@ -177752,8 +173701,7 @@ declare namespace Word { * Represents the collection of {@link Word.XmlNode} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface XmlNodeCollectionLoadOptions { /** @@ -177764,145 +173712,129 @@ declare namespace Word { * For EACH ITEM in the collection: Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ firstChild?: Word.Interfaces.XmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lastChild?: Word.Interfaces.XmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ nextSibling?: Word.Interfaces.XmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets the parent document of this XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ownerDocument?: Word.Interfaces.DocumentLoadOptions; /** * For EACH ITEM in the collection: Gets the parent element of this XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ parentNode?: Word.Interfaces.XmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previousSibling?: Word.Interfaces.XmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Gets the name of the element without any prefix. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ baseName?: boolean; /** * For EACH ITEM in the collection: Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hasChildNodes?: boolean; /** * For EACH ITEM in the collection: Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ level?: boolean; /** * For EACH ITEM in the collection: Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ namespaceUri?: boolean; /** - * For EACH ITEM in the collection: Gets the type of node. + * For EACH ITEM in the collection: Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - nodeType?: boolean; + placeholderText?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. + * For EACH ITEM in the collection: Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - nodeValue?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. + * For EACH ITEM in the collection: Gets the type of node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. + * For EACH ITEM in the collection: Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - text?: boolean; + validationErrorText?: boolean; /** - * For EACH ITEM in the collection: Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. + * For EACH ITEM in the collection: Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - validationErrorText?: boolean; + validationStatus?: boolean; /** - * For EACH ITEM in the collection: Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. + * For EACH ITEM in the collection: Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - validationStatus?: boolean; + value?: boolean; } /** * Represents a single XML node applied to the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface XmlNodeLoadOptions { /** @@ -177913,143 +173845,127 @@ declare namespace Word { * Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ firstChild?: Word.Interfaces.XmlNodeLoadOptions; /** * Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ lastChild?: Word.Interfaces.XmlNodeLoadOptions; /** * Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ nextSibling?: Word.Interfaces.XmlNodeLoadOptions; /** * Gets the parent document of this XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ ownerDocument?: Word.Interfaces.DocumentLoadOptions; /** * Gets the parent element of this XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ parentNode?: Word.Interfaces.XmlNodeLoadOptions; /** * Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ previousSibling?: Word.Interfaces.XmlNodeLoadOptions; /** * Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the name of the element without any prefix. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ baseName?: boolean; /** * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hasChildNodes?: boolean; /** * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ level?: boolean; /** * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ namespaceUri?: boolean; /** - * Gets the type of node. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - nodeType?: boolean; + placeholderText?: boolean; /** - * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - nodeValue?: boolean; + text?: boolean; /** - * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. + * Gets the type of node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: boolean; + type?: boolean; /** - * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - text?: boolean; + validationErrorText?: boolean; /** - * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ - validationErrorText?: boolean; + validationStatus?: boolean; /** - * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - validationStatus?: boolean; + value?: boolean; } /** * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface HtmlDivisionLoadOptions { /** @@ -178060,40 +173976,35 @@ declare namespace Word { * Gets a `Range` object that represents the portion of a document that's contained in this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies the left indent value (in points) for this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftIndent?: boolean; /** * Specifies the right indent (in points) for this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightIndent?: boolean; /** * Specifies the amount of spacing (in points) after this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaceAfter?: boolean; /** * Specifies the spacing (in points) before this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaceBefore?: boolean; } @@ -178101,8 +174012,7 @@ declare namespace Word { * Represents a collection of {@link Word.HtmlDivision} objects in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface HtmlDivisionCollectionLoadOptions { /** @@ -178113,40 +174023,35 @@ declare namespace Word { * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of a document that's contained in this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies the left indent value (in points) for this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ leftIndent?: boolean; /** * For EACH ITEM in the collection: Specifies the right indent (in points) for this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightIndent?: boolean; /** * For EACH ITEM in the collection: Specifies the amount of spacing (in points) after this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaceAfter?: boolean; /** * For EACH ITEM in the collection: Specifies the spacing (in points) before this HTML division. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spaceBefore?: boolean; } @@ -178440,8 +174345,7 @@ declare namespace Word { * Represents a dropped capital letter in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface DropCapLoadOptions { /** @@ -178452,32 +174356,28 @@ declare namespace Word { * Gets the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ distanceFromText?: boolean; /** * Gets the name of the font for the dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fontName?: boolean; /** * Gets the height (in lines) of the dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ linesToDrop?: boolean; /** * Gets the position of the dropped capital letter. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ position?: boolean; } @@ -179661,10 +175561,9 @@ declare namespace Word { * Represents a selected range or the insertion point in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] + * [Api set: WordApiDesktop 1.4] * * Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. - * @beta */ interface SelectionLoadOptions { /** @@ -179675,48 +175574,42 @@ declare namespace Word { * Returns the `Font` object that represents the character formatting of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ font?: Word.Interfaces.FontLoadOptions; /** * Specifies a `Range` object that includes the formatted text in the range or selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ formattedText?: Word.Interfaces.RangeLoadOptions; /** * Returns the `Range` object for the portion of the document contained in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Returns the `ShadingUniversal` object for the shading formatting for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Specifies the ending character position of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: boolean; /** * Specifies the width in which Word fits the text in the current selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitTextWidth?: boolean; /** @@ -179724,136 +175617,119 @@ declare namespace Word { If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ hasNoProofing?: boolean; /** * Returns whether the selection in the specified window or pane is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isActive?: boolean; /** * Specifies whether column selection mode is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isColumnSelectModeActive?: boolean; /** * Returns whether the selection is at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEndOfRowMark?: boolean; /** * Specifies whether Extend mode is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isExtendModeActive?: boolean; /** * Returns whether the insertion point is at the end of a line. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isInsertionPointAtEndOfLine?: boolean; /** * Specifies whether the beginning of the selection is active. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isStartActive?: boolean; /** * Specifies whether Word has detected the language of the selected text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageDetected?: boolean; /** * Returns the language for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageId?: boolean; /** * Returns the East Asian language for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageIdFarEast?: boolean; /** * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ languageIdOther?: boolean; /** * Specifies the orientation of text in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ orientation?: boolean; /** * Specifies the starting character position of the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: boolean; /** * Returns the number of characters in the story that contains the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyLength?: boolean; /** * Returns the story type for the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyType?: boolean; /** * Specifies the text in the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ text?: boolean; /** * Returns the selection type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -179861,8 +175737,7 @@ declare namespace Word { * Represents a collection of {@link Word.Range} objects that represents each character, word, or sentence. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface RangeScopedCollectionLoadOptions { /** @@ -179880,7 +175755,7 @@ declare namespace Word { * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] + * [Api set: WordApiDesktop 1.4] */ listFormat?: Word.Interfaces.ListFormatLoadOptions; /** @@ -179936,87 +175811,77 @@ declare namespace Word { * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ bold?: boolean; /** * For EACH ITEM in the collection: Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ boldBidirectional?: boolean; /** * For EACH ITEM in the collection: Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ case?: boolean; /** * For EACH ITEM in the collection: Specifies the character width of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ characterWidth?: boolean; /** * For EACH ITEM in the collection: Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ combineCharacters?: boolean; /** * For EACH ITEM in the collection: Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ disableCharacterSpaceGrid?: boolean; /** * For EACH ITEM in the collection: Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ emphasisMark?: boolean; /** * For EACH ITEM in the collection: Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: boolean; /** * For EACH ITEM in the collection: Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ fitTextWidth?: boolean; /** * For EACH ITEM in the collection: Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ grammarChecked?: boolean; /** @@ -180030,16 +175895,14 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ highlightColorIndex?: boolean; /** * For EACH ITEM in the collection: Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ horizontalInVertical?: boolean; /** @@ -180053,8 +175916,7 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies the ID for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ id?: boolean; /** @@ -180068,40 +175930,35 @@ declare namespace Word { * For EACH ITEM in the collection: Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEndOfRowMark?: boolean; /** * For EACH ITEM in the collection: Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isTextVisibleOnScreen?: boolean; /** * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ italic?: boolean; /** * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ italicBidirectional?: boolean; /** * For EACH ITEM in the collection: Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ kana?: boolean; /** @@ -180136,40 +175993,35 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ showAll?: boolean; /** * For EACH ITEM in the collection: Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ spellingChecked?: boolean; /** * For EACH ITEM in the collection: Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: boolean; /** * For EACH ITEM in the collection: Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyLength?: boolean; /** * For EACH ITEM in the collection: Gets the story type for the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyType?: boolean; /** @@ -180197,8 +176049,7 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ twoLinesInOne?: boolean; /** @@ -180215,8 +176066,7 @@ declare namespace Word { The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface BookmarkLoadOptions { /** @@ -180227,56 +176077,49 @@ declare namespace Word { * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies the ending character position of the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: boolean; /** * Returns `true` if the bookmark is a table column. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isColumn?: boolean; /** * Returns `true` if the bookmark is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEmpty?: boolean; /** * Returns the name of the `Bookmark` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; /** * Specifies the starting character position of the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: boolean; /** * Returns the story type for the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyType?: boolean; } @@ -180284,8 +176127,7 @@ declare namespace Word { * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface BookmarkCollectionLoadOptions { /** @@ -180296,56 +176138,49 @@ declare namespace Word { * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies the ending character position of the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ end?: boolean; /** * For EACH ITEM in the collection: Returns `true` if the bookmark is a table column. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isColumn?: boolean; /** * For EACH ITEM in the collection: Returns `true` if the bookmark is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ isEmpty?: boolean; /** * For EACH ITEM in the collection: Returns the name of the `Bookmark` object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; /** * For EACH ITEM in the collection: Specifies the starting character position of the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ start?: boolean; /** * For EACH ITEM in the collection: Returns the story type for the bookmark. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ storyType?: boolean; } @@ -180354,8 +176189,7 @@ declare namespace Word { indexes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface IndexLoadOptions { /** @@ -180366,8 +176200,7 @@ declare namespace Word { * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** @@ -180375,8 +176208,7 @@ declare namespace Word { See `IndexFilter` for available values. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ filter?: boolean; /** @@ -180384,32 +176216,28 @@ declare namespace Word { the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ headingSeparator?: boolean; /** * Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ indexLanguage?: boolean; /** * Gets the number of columns for each page of the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ numberOfColumns?: boolean; /** * Specifies if page numbers are aligned with the right margin in the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightAlignPageNumbers?: boolean; /** @@ -180417,32 +176245,28 @@ declare namespace Word { one heading and words that begin with "A" are under another). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ separateAccentedLetterHeadings?: boolean; /** * Specifies the sorting criteria for the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sortBy?: boolean; /** * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: boolean; /** * Gets the index type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -180450,8 +176274,7 @@ declare namespace Word { * A collection of {@link Word.Index} objects that represents all the indexes in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface IndexCollectionLoadOptions { /** @@ -180462,8 +176285,7 @@ declare namespace Word { * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ range?: Word.Interfaces.RangeLoadOptions; /** @@ -180471,8 +176293,7 @@ declare namespace Word { See `IndexFilter` for available values. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ filter?: boolean; /** @@ -180480,32 +176301,28 @@ declare namespace Word { the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ headingSeparator?: boolean; /** * For EACH ITEM in the collection: Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ indexLanguage?: boolean; /** * For EACH ITEM in the collection: Gets the number of columns for each page of the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ numberOfColumns?: boolean; /** * For EACH ITEM in the collection: Specifies if page numbers are aligned with the right margin in the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ rightAlignPageNumbers?: boolean; /** @@ -180513,32 +176330,28 @@ declare namespace Word { one heading and words that begin with "A" are under another). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ separateAccentedLetterHeadings?: boolean; /** * For EACH ITEM in the collection: Specifies the sorting criteria for the index. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ sortBy?: boolean; /** * For EACH ITEM in the collection: Specifies the leader character between entries in the index and their associated page numbers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ tabLeader?: boolean; /** * For EACH ITEM in the collection: Gets the index type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } @@ -180546,8 +176359,7 @@ declare namespace Word { * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ interface ListTemplateCollectionLoadOptions { /** @@ -180558,8 +176370,7 @@ declare namespace Word { * For EACH ITEM in the collection: Specifies the name of the list template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.4] */ name?: boolean; /** diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index edf62faded938e..a663211ebeac63 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -94248,6 +94248,327 @@ declare namespace Excel { //////////////////////////////////////////////////////////////// declare namespace Word { + /** + * Represents the {@link Word.Editor | editors} in a protected (read-only) Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class EditorCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns an `Editor` object that represents a new permission for the specified user to modify a range within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param editorId The user's email alias (if in the same domain) or an email address. + */ + addById(editorId: string): Word.Editor; + /** + * Returns an `Editor` object that represents a new permission for the specified group of users to modify a range within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param editorType An `EditorType` that represents a group of users. + */ + addByType(editorType: Word.EditorType): Word.Editor; + /** + * Returns an `Editor` object that represents a new permission for the specified group of users to modify a range within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param editorType An `EditorType` that represents a group of users. + */ + addByType(editorType: "Current" | "Editors" | "Everyone" | "Owners"): Word.Editor; + /** + * Returns the number of items in the collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets an `Editor` object by its index in the collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param index The index of the item to retrieve. + */ + getItemAt(index: number): Word.Editor; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.EditorCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.EditorCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.EditorCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.EditorCollection; + /** + * 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.EditorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.EditorCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class Editor extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly nextRange: Word.Range; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly range: Word.Range; + /** + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly id: string; + /** + * Gets the name of the editor. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly name: string; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.EditorUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Editor): void; + /** + * Deletes the `Editor` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + delete(): void; + /** + * Removes all editing permissions in the document for the editor. The editor will be deleted next time the document opens. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + removeAllPermissions(): void; + /** + * Selects all the shapes in the document that were inserted or edited by the editor. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectAllShapes(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.EditorLoadOptions): Word.Editor; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.Editor; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Editor; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Editor; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Editor; + /** + * 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.Editor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.EditorData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.EditorData; + } + /** + * Represents the coauthoring conflicts in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class ConflictCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Conflict[]; + /** + * Accepts all of the user's changes, removes the conflicts, and merges the changes into the server copy of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + acceptAll(): void; + /** + * Rejects all of the user's changes and retains the server copy of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + rejectAll(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ConflictCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ConflictCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ConflictCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ConflictCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ConflictCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ConflictCollection; + /** + * 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.ConflictCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConflictCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ConflictCollectionData; + } + /** + * Represents a coauthoring conflict in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class Conflict extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly range: Word.Range; + /** + * Gets the `RevisionType` for the `Conflict` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConflictUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Conflict): void; + /** + * Accepts the user's change and removes the conflict. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + accept(): void; + /** + * Rejects the user's change, removes the conflict, and accepts the server copy of the change for the conflict. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + reject(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ConflictLoadOptions): Word.Conflict; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.Conflict; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Conflict; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Conflict; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Conflict; + /** + * 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.Conflict` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConflictData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ConflictData; + } /** * Represents the color scheme of a critique in the document, affecting underline and highlight. * @@ -94707,6 +95028,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ readonly bibliography: Word.Bibliography; + /** + * Returns a `FontNameCollection` object that represents all the available font names in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly fontNames: Word.FontNameCollection; + /** + * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly listTemplateGalleries: Word.ListTemplateGalleryCollection; /** * Returns a `TemplateCollection` object that represents all the available templates: global templates and those attached to open documents. * @@ -96280,113 +96615,62 @@ declare namespace Word { toJSON(): Word.Interfaces.CheckboxContentControlData; } /** - * Represents a comment in the document. + * Represents a coauthoring lock in a Word document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - class Comment extends OfficeExtension.ClientObject { + class CoauthoringLock extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange: Word.CommentContentRange; - /** - * Gets the collection of reply objects associated with the comment. - * - * @remarks - * [Api set: WordApi 1.4] - */ - readonly replies: Word.CommentReplyCollection; - /** - * Gets the email of the comment's author. - * - * @remarks - * [Api set: WordApi 1.4] - */ - readonly authorEmail: string; - /** - * Gets the name of the comment's author. - * - * @remarks - * [Api set: WordApi 1.4] - */ - readonly authorName: string; - /** - * Specifies the comment's content as plain text. - * - * @remarks - * [Api set: WordApi 1.4] - */ - content: string; - /** - * Gets the creation date of the comment. + * Gets the owner of the lock. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly creationDate: Date; + readonly owner: Word.Coauthor; /** - * Gets the ID of the comment. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly id: string; + readonly range: Word.Range; /** - * Specifies the comment thread's status. Setting to `true` resolves the comment thread. Getting a value of `true` means that the comment thread is resolved. + * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - resolved: boolean; + readonly type: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.CoauthoringLockUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Comment): void; - /** - * Deletes the comment and its replies. - * - * @remarks - * [Api set: WordApi 1.4] - */ - delete(): void; - /** - * Gets the range in the main document where the comment is on. - * - * @remarks - * [Api set: WordApi 1.4] - */ - getRange(): Word.Range; + set(properties: Word.CoauthoringLock): void; /** - * Adds a new reply to the end of the comment thread. + * Removes this lock, even if it belongs to a different user. * * @remarks - * [Api set: WordApi 1.4] - * - * @param replyText Reply text. + * [Api set: WordApiDesktop 1.4] */ - reply(replyText: string): Word.CommentReply; + unlock(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CommentLoadOptions): Word.Comment; + load(options?: Word.Interfaces.CoauthoringLockLoadOptions): Word.CoauthoringLock; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Comment; + load(propertyNames?: string | string[]): Word.CoauthoringLock; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -96395,274 +96679,301 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Comment; + }): Word.CoauthoringLock; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Comment; + track(): Word.CoauthoringLock; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Comment; + untrack(): Word.CoauthoringLock; /** * 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.Comment` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.CoauthoringLock` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringLockData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CommentData; + toJSON(): Word.Interfaces.CoauthoringLockData; } /** - * Contains a collection of {@link Word.Comment} objects. + * Represents a collection of coauthoring locks in a Word document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - class CommentCollection extends OfficeExtension.ClientObject { + class CoauthoringLockCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.Comment[]; + readonly items: Word.CoauthoringLock[]; /** - * Gets the first comment in the collection. Throws an `ItemNotFound` error if this collection is empty. + * Returns a `CoauthoringLock` object that represents a lock added to a specified range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. The options to further configure the coauthoring lock. */ - getFirst(): Word.Comment; + add(options?: Word.CoauthoringLockAddOptions): Word.CoauthoringLock; /** - * Gets the first comment in the collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Removes all ephemeral locks from the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - getFirstOrNullObject(): Word.Comment; + unlockEphemeralLocks(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CommentCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentCollection; + load(options?: Word.Interfaces.CoauthoringLockCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CoauthoringLockCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.CommentCollection; + load(propertyNames?: string | string[]): Word.CoauthoringLockCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CoauthoringLockCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CommentCollection; + track(): Word.CoauthoringLockCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CommentCollection; + untrack(): Word.CoauthoringLockCollection; /** * 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.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.CoauthoringLockCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringLockCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.CommentCollectionData; + toJSON(): Word.Interfaces.CoauthoringLockCollectionData; } /** - * Represents a content range within a comment. + * Specifies the options for adding to a {@link Word.CoauthoringLockCollection} object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - class CommentContentRange extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + interface CoauthoringLockAddOptions { /** - * Specifies whether the comment text is bold. + * If provided, specifies the range to which the lock is added. If not provided, the new lock is placed on the paragraph that contains the insertion point. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - bold: boolean; + range?: Word.Range; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * If provided, specifies the type of lock. If not provided, the lock type is set to `reservation`. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - hyperlink: string; + type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; + } + /** + * Represents a coauthor in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class Coauthor extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Checks whether the range length is zero. + * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly isEmpty: boolean; + readonly locks: Word.CoauthoringLockCollection; /** - * Specifies whether the comment text is italicized. + * Gets the email address of the coauthor. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - italic: boolean; + readonly emailAddress: string; /** - * Specifies whether the comment text has a strikethrough. + * Gets the unique identifier for the `Coauthor` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - strikeThrough: boolean; + readonly id: string; /** - * Gets the text of the comment range. + * Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly text: string; + readonly isMe: boolean; /** - * Specifies the comment text's underline type. `none` if the comment text isn't underlined. + * Gets the display name of the coauthor. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + readonly name: string; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - set(properties: Interfaces.CommentContentRangeUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.CommentContentRange): void; + load(options?: Word.Interfaces.CoauthorLoadOptions): Word.Coauthor; /** - * Inserts text into at the specified location. **Note**: For the modern comment, the content range tracked across context turns to empty if any revision to the comment is posted through the UI. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.4] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.Coauthor; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param text The text to be inserted in to the `CommentContentRange`. - * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Coauthor; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Coauthor; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Coauthor; + /** + * 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.Coauthor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthorData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CoauthorData; + } + /** + * Contains a collection of {@link Word.Coauthor} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class CoauthorCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Coauthor[]; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange; + load(options?: Word.Interfaces.CoauthorCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CoauthorCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.CommentContentRange; + load(propertyNames?: string | string[]): Word.CoauthorCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.CommentContentRange; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CoauthorCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CommentContentRange; + track(): Word.CoauthorCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CommentContentRange; + untrack(): Word.CoauthorCollection; /** * 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.CommentContentRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.CoauthorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthorCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.CommentContentRangeData; + toJSON(): Word.Interfaces.CoauthorCollectionData; } /** - * Represents a comment reply in the document. + * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - class CommentReply extends OfficeExtension.ClientObject { + class Coauthoring extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies the commentReply's content range. + * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - contentRange: Word.CommentContentRange; + readonly authors: Word.CoauthorCollection; /** - * Gets the parent comment of this reply. + * Gets a `ConflictCollection` object that represents all the conflicts in the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly parentComment: Word.Comment; + readonly conflicts: Word.ConflictCollection; /** - * Gets the email of the comment reply's author. + * Gets a `CoauthoringLockCollection` object that represents the locks in the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly authorEmail: string; + readonly locks: Word.CoauthoringLockCollection; /** - * Gets the name of the comment reply's author. + * Gets a `Coauthor` object that represents the current user. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly authorName: string; + readonly me: Word.Coauthor; /** - * Specifies the comment reply's content. The string is plain text. + * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - content: string; + readonly updates: Word.CoauthoringUpdateCollection; /** - * Gets the creation date of the comment reply. + * Gets whether this document can be coauthored. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly creationDate: Date; + readonly canCoauthor: boolean; /** - * Gets the ID of the comment reply. + * Gets whether the document can be automatically merged. * * @remarks - * [Api set: WordApi 1.4] - */ - readonly id: string; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.CommentReply): void; + readonly canMerge: boolean; /** - * Deletes the comment reply. + * Gets whether the document has pending updates that have not been accepted. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - delete(): void; + readonly pendingUpdates: boolean; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CommentReplyLoadOptions): Word.CommentReply; + load(options?: Word.Interfaces.CoauthoringLoadOptions): Word.Coauthoring; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.CommentReply; + load(propertyNames?: string | string[]): Word.Coauthoring; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -96671,168 +96982,231 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.CommentReply; + }): Word.Coauthoring; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CommentReply; + track(): Word.Coauthoring; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CommentReply; + untrack(): Word.Coauthoring; /** * 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.CommentReply` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Coauthoring` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CommentReplyData; + toJSON(): Word.Interfaces.CoauthoringData; } /** - * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. + * Represents a coauthoring update in a Word document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - class CommentReplyCollection extends OfficeExtension.ClientObject { + class CoauthoringUpdate extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.CommentReply[]; /** - * Gets the first comment reply in the collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - getFirst(): Word.CommentReply; + readonly range: Word.Range; /** - * Gets the first comment reply in the collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - getFirstOrNullObject(): Word.CommentReply; + set(properties: Interfaces.CoauthoringUpdateUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CoauthoringUpdate): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CommentReplyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentReplyCollection; + load(options?: Word.Interfaces.CoauthoringUpdateLoadOptions): Word.CoauthoringUpdate; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.CommentReplyCollection; + load(propertyNames?: string | string[]): Word.CoauthoringUpdate; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentReplyCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.CoauthoringUpdate; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CommentReplyCollection; + track(): Word.CoauthoringUpdate; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CommentReplyCollection; + untrack(): Word.CoauthoringUpdate; /** * 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.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.CoauthoringUpdate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringUpdateData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CommentReplyCollectionData; + toJSON(): Word.Interfaces.CoauthoringUpdateData; } /** - * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. + * Contains a collection of {@link Word.CoauthoringUpdate} objects. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - class XmlMapping extends OfficeExtension.ClientObject { + class CoauthoringUpdateCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.CoauthoringUpdate[]; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param options Provides options for which properties of the object to load. */ - readonly customXmlNode: Word.CustomXmlNode; + load(options?: Word.Interfaces.CoauthoringUpdateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CoauthoringUpdateCollection; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly customXmlPart: Word.CustomXmlPart; + load(propertyNames?: string | string[]): Word.CoauthoringUpdateCollection; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - readonly isMapped: boolean; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CoauthoringUpdateCollection; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CoauthoringUpdateCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CoauthoringUpdateCollection; + /** + * 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.CoauthoringUpdateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringUpdateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CoauthoringUpdateCollectionData; + } + /** + * Represents a comment in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + class Comment extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the comment's content range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - readonly prefixMappings: string; + contentRange: Word.CommentContentRange; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * Gets the collection of reply objects associated with the comment. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - readonly xpath: string; + readonly replies: Word.CommentReplyCollection; + /** + * Gets the email of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly authorEmail: string; + /** + * Gets the name of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly authorName: string; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content: string; + /** + * Gets the creation date of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly creationDate: Date; + /** + * Gets the ID of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly id: string; + /** + * Specifies the comment thread's status. Setting to `true` resolves the comment thread. Getting a value of `true` means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved: boolean; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.XmlMappingUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.XmlMapping): void; + set(properties: Word.Comment): void; /** - * Deletes the XML mapping from the parent content control. + * Deletes the comment and its replies. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ delete(): void; /** - * Allows creating or changing the XML mapping on the content control. + * Gets the range in the main document where the comment is on. * * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param xPath The XPath expression to evaluate. - * @param options Optional. The options available for setting the XML mapping. + * [Api set: WordApi 1.4] */ - setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult; + getRange(): Word.Range; /** - * Allows creating or changing the XML data mapping on the content control. + * Adds a new reply to the end of the comment thread. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] * - * @param node The custom XML node to map. + * @param replyText Reply text. */ - setMappingByNode(node: Word.CustomXmlNode): OfficeExtension.ClientResult; + reply(replyText: string): Word.CommentReply; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.XmlMappingLoadOptions): Word.XmlMapping; + load(options?: Word.Interfaces.CommentLoadOptions): Word.Comment; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.XmlMapping; + load(propertyNames?: string | string[]): Word.Comment; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -96841,156 +97215,166 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.XmlMapping; + }): Word.Comment; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.XmlMapping; + track(): Word.Comment; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.XmlMapping; + untrack(): Word.Comment; /** * 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.XmlMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlMappingData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Comment` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.XmlMappingData; - } - /** - * The options that define the prefix mapping and the source of the custom XML data. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface XmlSetMappingOptions { - /** - * If provided, specifies the prefix mappings to use when querying the expression provided in the `xPath` parameter of the `XmlMapping.setMapping` calling method. If omitted, Word uses the set of prefix mappings for the specified custom XML part in the current document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - prefixMapping?: string; - /** - * If provided, specifies the desired custom XML data to map the content control to. If this property is omitted, the XPath is evaluated against all custom XML in the current document, and the mapping is established with the first `CustomXmlPart` where the XPath resolves to an XML node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - source?: Word.CustomXmlPart; + toJSON(): Word.Interfaces.CommentData; } /** - * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. + * Contains a collection of {@link Word.Comment} objects. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - class CustomXmlPrefixMappingCollection extends OfficeExtension.ClientObject { + class CommentCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.CustomXmlPrefixMapping[]; - /** - * Adds a custom namespace/prefix mapping to use when querying an item. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param prefix The prefix to associate with the namespace. - * @param namespaceUri The namespace URI to map. - */ - addNamespace(prefix: string, namespaceUri: string): OfficeExtension.ClientResult; - /** - * Returns the number of items in the collection. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - getCount(): OfficeExtension.ClientResult; + readonly items: Word.Comment[]; /** - * Gets the namespace corresponding to the specified prefix. + * Gets the first comment in the collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param prefix The prefix to look up. + * [Api set: WordApi 1.4] */ - lookupNamespace(prefix: string): OfficeExtension.ClientResult; + getFirst(): Word.Comment; /** - * Gets the prefix corresponding to the specified namespace. + * Gets the first comment in the collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param namespaceUri The namespace URI to look up. + * [Api set: WordApi 1.4] */ - lookupPrefix(namespaceUri: string): OfficeExtension.ClientResult; + getFirstOrNullObject(): Word.Comment; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CustomXmlPrefixMappingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlPrefixMappingCollection; + load(options?: Word.Interfaces.CommentCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.CustomXmlPrefixMappingCollection; + load(propertyNames?: string | string[]): Word.CommentCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlPrefixMappingCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlPrefixMappingCollection; + track(): Word.CommentCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlPrefixMappingCollection; + untrack(): Word.CommentCollection; /** * 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.CustomXmlPrefixMappingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.CustomXmlPrefixMappingCollectionData; + toJSON(): Word.Interfaces.CommentCollectionData; } /** - * Represents a `CustomXmlPrefixMapping` object. + * Represents a content range within a comment. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - class CustomXmlPrefixMapping extends OfficeExtension.ClientObject { + class CommentContentRange extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Specifies whether the comment text is bold. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - readonly namespaceUri: string; + bold: boolean; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - readonly prefix: string; + hyperlink: string; + /** + * Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly isEmpty: boolean; + /** + * Specifies whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic: boolean; + /** + * Specifies whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough: boolean; + /** + * Gets the text of the comment range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly text: string; + /** + * Specifies the comment text's underline type. `none` if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CommentContentRangeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CommentContentRange): void; + /** + * Inserts text into at the specified location. **Note**: For the modern comment, the content range tracked across context turns to empty if any revision to the comment is posted through the UI. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param text The text to be inserted in to the `CommentContentRange`. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. + */ + insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CustomXmlPrefixMappingLoadOptions): Word.CustomXmlPrefixMapping; + load(options?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.CustomXmlPrefixMapping; + load(propertyNames?: string | string[]): Word.CommentContentRange; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -96999,70 +97383,106 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.CustomXmlPrefixMapping; + }): Word.CommentContentRange; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlPrefixMapping; + track(): Word.CommentContentRange; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlPrefixMapping; + untrack(): Word.CommentContentRange; /** * 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.CustomXmlPrefixMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.CommentContentRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CustomXmlPrefixMappingData; + toJSON(): Word.Interfaces.CommentContentRangeData; } /** - * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. + * Represents a comment reply in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - class CustomXmlSchema extends OfficeExtension.ClientObject { + class CommentReply extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the location of the schema on a computer. + * Specifies the commentReply's content range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - readonly location: string; + contentRange: Word.CommentContentRange; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Gets the parent comment of this reply. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - readonly namespaceUri: string; + readonly parentComment: Word.Comment; /** - * Deletes this schema from the {@link Word.CustomXmlSchemaCollection} object. + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - delete(): void; + readonly authorEmail: string; /** - * Reloads the schema from a file. + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - reload(): void; + readonly authorName: string; + /** + * Specifies the comment reply's content. The string is plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content: string; + /** + * Gets the creation date of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly creationDate: Date; + /** + * Gets the ID of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly id: string; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CommentReply): void; + /** + * Deletes the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + delete(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CustomXmlSchemaLoadOptions): Word.CustomXmlSchema; + load(options?: Word.Interfaces.CommentReplyLoadOptions): Word.CommentReply; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.CustomXmlSchema; + load(propertyNames?: string | string[]): Word.CommentReply; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -97071,725 +97491,1225 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.CustomXmlSchema; + }): Word.CommentReply; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlSchema; + track(): Word.CommentReply; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlSchema; + untrack(): Word.CommentReply; /** * 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.CustomXmlSchema` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.CommentReply` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CustomXmlSchemaData; + toJSON(): Word.Interfaces.CommentReplyData; } /** - * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. + * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - class CustomXmlSchemaCollection extends OfficeExtension.ClientObject { + class CommentReplyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.CustomXmlSchema[]; - /** - * Adds one or more schemas to the schema collection that can then be added to a stream in the data store and to the schema library. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param options Optional. The options that define the schema to be added. - */ - add(options?: Word.CustomXmlAddSchemaOptions): Word.CustomXmlSchema; - /** - * Adds an existing schema collection to the current schema collection. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param schemaCollection The schema collection to add. - */ - addCollection(schemaCollection: Word.CustomXmlSchemaCollection): Word.CustomXmlSchemaCollection; - /** - * Returns the number of items in the collection. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - getCount(): OfficeExtension.ClientResult; - /** - * Returns a `CustomXmlSchema` object that represents the specified item in the collection. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param index The location of a `CustomXmlSchema` object. - */ - getItem(index: number): Word.CustomXmlSchema; + readonly items: Word.CommentReply[]; /** - * Returns the number of items in the collection. + * Gets the first comment reply in the collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - getNamespaceUri(): OfficeExtension.ClientResult; + getFirst(): Word.CommentReply; /** - * Specifies whether the schemas in the schema collection are valid (conforms to the syntactic rules of XML and the rules for a specified vocabulary). + * Gets the first comment reply in the collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - validate(): OfficeExtension.ClientResult; + getFirstOrNullObject(): Word.CommentReply; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlSchemaCollection; + load(options?: Word.Interfaces.CommentReplyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentReplyCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.CustomXmlSchemaCollection; + load(propertyNames?: string | string[]): Word.CommentReplyCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlSchemaCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CommentReplyCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlSchemaCollection; + track(): Word.CommentReplyCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlSchemaCollection; + untrack(): Word.CommentReplyCollection; /** * 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.CustomXmlSchemaCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.CustomXmlSchemaCollectionData; + toJSON(): Word.Interfaces.CommentReplyCollectionData; } /** - * Adds one or more schemas to a schema collection that can then be added to a stream in the data store and to the schema library. + * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - interface CustomXmlAddSchemaOptions { + class ConditionalStyle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * If provided, specifies the alias of the schema to be added to the collection. However, if the alias already exists in the Schema Library, the schema can be found using this value. + * Returns a `BorderUniversalCollection` object that represents all the borders for the conditional style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - alias?: string; + readonly borders: Word.BorderUniversalCollection; /** - * If provided, specifies the location of the schema on a disk. If this property is specified, the schema is added to the collection and to the Schema Library. + * Returns a `Font` object that represents the font formatting for the conditional style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - fileName?: string; + readonly font: Word.Font; /** - * If provided, specifies whether, in the case where the schema is being added to the Schema Library, the Schema Library keys should be written to the registry (`HKEY_LOCAL_MACHINE` for all users or `HKEY_CURRENT_USER` for just the current user). The property defaults to `false` and writes to `HKEY_CURRENT_USER`. + * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - installForAllUsers?: boolean; + readonly paragraphFormat: Word.ParagraphFormat; /** - * If provided, specifies the namespace of the schema to be added to the collection. However, if the schema already exists in the Schema Library, the schema will be retrieved from there. + * Returns a `ShadingUniversal` object that represents the shading of the conditional style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - namespaceUri?: string; - } - /** - * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class CustomXmlNodeCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.CustomXmlNode[]; + readonly shading: Word.ShadingUniversal; /** - * Returns the number of items in the collection. + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - getCount(): OfficeExtension.ClientResult; + bottomPadding: number; + /** + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + leftPadding: number; + /** + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + rightPadding: number; + /** + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + topPadding: number; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CustomXmlNodeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlNodeCollection; + load(options?: Word.Interfaces.ConditionalStyleLoadOptions): Word.ConditionalStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.CustomXmlNodeCollection; + load(propertyNames?: string | string[]): Word.ConditionalStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlNodeCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ConditionalStyle; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlNodeCollection; + track(): Word.ConditionalStyle; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlNodeCollection; + untrack(): Word.ConditionalStyle; /** * 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.CustomXmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.ConditionalStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConditionalStyleData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CustomXmlNodeCollectionData; + toJSON(): Word.Interfaces.ConditionalStyleData; } /** - * The options that define the prefix mapping and the source of the custom XML data. + * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface CustomXmlAppendChildNodeOptions { + class XmlMapping extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * If provided, specifies the base name of the element to be appended. + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks * [Api set: WordApiDesktop 1.3] */ - name?: string; + readonly customXmlNode: Word.CustomXmlNode; /** - * If provided, specifies the namespace of the element to be appended. This property is required to append nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks * [Api set: WordApiDesktop 1.3] */ - namespaceUri?: string; + readonly customXmlPart: Word.CustomXmlPart; /** - * If provided, specifies the type of node to append. If the property isn't specified, it's assumed to be of type `element`. + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + readonly isMapped: boolean; /** - * If provided, specifies the value of the appended node for those nodes that allow text. If the node doesn't allow text, the property is ignored. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nodeValue?: string; - } - /** - * Inserts a new node just before the context node in the tree. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface CustomXmlInsertNodeBeforeOptions { + readonly prefixMappings: string; /** - * If provided, specifies the base name of the element to be inserted. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks * [Api set: WordApiDesktop 1.3] */ - name?: string; + readonly xpath: string; /** - * If provided, specifies the namespace of the element to be inserted. This property is required to insert nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.XmlMappingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.XmlMapping): void; + /** + * Deletes the XML mapping from the parent content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - namespaceUri?: string; + delete(): void; /** - * If provided, specifies the context node. + * Allows creating or changing the XML mapping on the content control. * * @remarks * [Api set: WordApiDesktop 1.3] + * + * @param xPath The XPath expression to evaluate. + * @param options Optional. The options available for setting the XML mapping. */ - nextSibling?: Word.CustomXmlNode; + setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult; /** - * If provided, specifies the type of node to append. If the property isn't specified, it's assumed to be of type `element`. + * Allows creating or changing the XML data mapping on the content control. * * @remarks * [Api set: WordApiDesktop 1.3] + * + * @param node The custom XML node to map. */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + setMappingByNode(node: Word.CustomXmlNode): OfficeExtension.ClientResult; /** - * If provided, specifies the value of the inserted node for those nodes that allow text. If the node doesn't allow text, the property is ignored. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param options Provides options for which properties of the object to load. */ - nodeValue?: string; - } - /** - * Inserts a new node just before the context node in the tree. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface CustomXmlInsertSubtreeBeforeOptions { + load(options?: Word.Interfaces.XmlMappingLoadOptions): Word.XmlMapping; /** - * If provided, specifies the context node. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - nextSibling?: Word.CustomXmlNode; + load(propertyNames?: string | string[]): Word.XmlMapping; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.XmlMapping; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.XmlMapping; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.XmlMapping; + /** + * 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.XmlMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlMappingData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.XmlMappingData; } /** - * Removes the specified child node and replaces it with a different node in the same location. + * The options that define the prefix mapping and the source of the custom XML data. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface CustomXmlReplaceChildNodeOptions { - /** - * If provided, specifies the base name of the replacement element. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - name?: string; - /** - * If provided, specifies the namespace of the replacement element. This property is required to replace nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - namespaceUri?: string; + interface XmlSetMappingOptions { /** - * If provided, specifies the type of the replacement node. If the property isn't specified, it's assumed to be of type `element`. + * If provided, specifies the prefix mappings to use when querying the expression provided in the `xPath` parameter of the `XmlMapping.setMapping` calling method. If omitted, Word uses the set of prefix mappings for the specified custom XML part in the current document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + prefixMapping?: string; /** - * If provided, specifies the value of the replacement node for those nodes that allow text. If the node doesn't allow text, the property is ignored. + * If provided, specifies the desired custom XML data to map the content control to. If this property is omitted, the XPath is evaluated against all custom XML in the current document, and the mapping is established with the first `CustomXmlPart` where the XPath resolves to an XML node. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nodeValue?: string; + source?: Word.CustomXmlPart; } /** - * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. + * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. * * @remarks * [Api set: WordApiDesktop 1.3] */ - class CustomXmlNode extends OfficeExtension.ClientObject { + class CustomXmlPrefixMappingCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.CustomXmlPrefixMapping[]; /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * Adds a custom namespace/prefix mapping to use when querying an item. * * @remarks * [Api set: WordApiDesktop 1.3] + * + * @param prefix The prefix to associate with the namespace. + * @param namespaceUri The namespace URI to map. */ - readonly attributes: Word.CustomXmlNodeCollection; + addNamespace(prefix: string, namespaceUri: string): OfficeExtension.ClientResult; /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly childNodes: Word.CustomXmlNodeCollection; + getCount(): OfficeExtension.ClientResult; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Gets the namespace corresponding to the specified prefix. * * @remarks * [Api set: WordApiDesktop 1.3] + * + * @param prefix The prefix to look up. */ - readonly firstChild: Word.CustomXmlNode; + lookupNamespace(prefix: string): OfficeExtension.ClientResult; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Gets the prefix corresponding to the specified namespace. * * @remarks * [Api set: WordApiDesktop 1.3] + * + * @param namespaceUri The namespace URI to look up. */ - readonly lastChild: Word.CustomXmlNode; + lookupPrefix(namespaceUri: string): OfficeExtension.ClientResult; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param options Provides options for which properties of the object to load. */ - readonly nextSibling: Word.CustomXmlNode; + load(options?: Word.Interfaces.CustomXmlPrefixMappingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlPrefixMappingCollection; /** - * Gets the object representing the part associated with this node. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly ownerPart: Word.CustomXmlPart; + load(propertyNames?: string | string[]): Word.CustomXmlPrefixMappingCollection; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - readonly parentNode: Word.CustomXmlNode; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlPrefixMappingCollection; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - readonly previousSibling: Word.CustomXmlNode; + track(): Word.CustomXmlPrefixMappingCollection; /** - * Gets the base name of the node without the namespace prefix, if one exists. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - readonly baseName: string; + untrack(): Word.CustomXmlPrefixMappingCollection; /** - * Gets the unique address identifier for the namespace of the node. + * 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.CustomXmlPrefixMappingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CustomXmlPrefixMappingCollectionData; + } + /** + * Represents a `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class CustomXmlPrefixMapping extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly namespaceUri: string; /** - * Gets the type of the current node. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly nodeType: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + readonly prefix: string; /** - * Specifies the value of the current node. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param options Provides options for which properties of the object to load. */ - nodeValue: string; + load(options?: Word.Interfaces.CustomXmlPrefixMappingLoadOptions): Word.CustomXmlPrefixMapping; /** - * Specifies the text for the current node. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - text: string; + load(propertyNames?: string | string[]): Word.CustomXmlPrefixMapping; /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - readonly xpath: string; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.CustomXmlPrefixMapping; /** - * Gets the XML representation of the current node and its children. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - readonly xml: string; + track(): Word.CustomXmlPrefixMapping; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - set(properties: Interfaces.CustomXmlNodeUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.CustomXmlNode): void; + untrack(): Word.CustomXmlPrefixMapping; /** - * Appends a single node as the last child under the context element node in the tree. + * 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.CustomXmlPrefixMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CustomXmlPrefixMappingData; + } + /** + * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class CustomXmlSchema extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the location of the schema on a computer. * * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param options Optional. The options that define the node to be appended. */ - appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions): OfficeExtension.ClientResult; + readonly location: string; /** - * Adds a subtree as the last child under the context element node in the tree. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param xml A string representing the XML subtree. */ - appendChildSubtree(xml: string): OfficeExtension.ClientResult; + readonly namespaceUri: string; /** - * Deletes the current node from the tree (including all of its children, if any exist). + * Deletes this schema from the {@link Word.CustomXmlSchemaCollection} object. * * @remarks * [Api set: WordApiDesktop 1.3] */ delete(): void; /** - * Specifies if the current element node has child element nodes. + * Reloads the schema from a file. * * @remarks * [Api set: WordApiDesktop 1.3] */ - hasChildNodes(): OfficeExtension.ClientResult; + reload(): void; /** - * Inserts a new node just before the context node in the tree. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.CustomXmlSchemaLoadOptions): Word.CustomXmlSchema; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param options Optional. The options that define the node to be inserted. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions): OfficeExtension.ClientResult; + load(propertyNames?: string | string[]): Word.CustomXmlSchema; /** - * Inserts the specified subtree into the location just before the context node. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.CustomXmlSchema; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlSchema; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlSchema; + /** + * 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.CustomXmlSchema` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CustomXmlSchemaData; + } + /** + * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class CustomXmlSchemaCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.CustomXmlSchema[]; + /** + * Adds one or more schemas to the schema collection that can then be added to a stream in the data store and to the schema library. * * @remarks * [Api set: WordApiDesktop 1.3] * - * @param xml A string representing the XML subtree. - * @param options Optional. The options available for inserting the subtree. + * @param options Optional. The options that define the schema to be added. */ - insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions): OfficeExtension.ClientResult; + add(options?: Word.CustomXmlAddSchemaOptions): Word.CustomXmlSchema; /** - * Removes the specified child node from the tree. + * Adds an existing schema collection to the current schema collection. * * @remarks * [Api set: WordApiDesktop 1.3] * - * @param child The child node to remove. + * @param schemaCollection The schema collection to add. */ - removeChild(child: Word.CustomXmlNode): OfficeExtension.ClientResult; + addCollection(schemaCollection: Word.CustomXmlSchemaCollection): Word.CustomXmlSchemaCollection; /** - * Removes the specified child node and replaces it with a different node in the same location. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param oldNode The node to be replaced. - * @param options Optional. The options that define the child node which is to replace the old node. */ - replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions): OfficeExtension.ClientResult; + getCount(): OfficeExtension.ClientResult; /** - * Removes the specified node and replaces it with a different subtree in the same location. + * Returns a `CustomXmlSchema` object that represents the specified item in the collection. * * @remarks * [Api set: WordApiDesktop 1.3] * - * @param xml A string representing the new subtree. - * @param oldNode The node to be replaced. + * @param index The location of a `CustomXmlSchema` object. */ - replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode): OfficeExtension.ClientResult; + getItem(index: number): Word.CustomXmlSchema; /** - * Selects a collection of nodes matching an XPath expression. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param xPath The XPath expression. */ - selectNodes(xPath: string): Word.CustomXmlNodeCollection; + getNamespaceUri(): OfficeExtension.ClientResult; /** - * Selects a single node from a collection matching an XPath expression. + * Specifies whether the schemas in the schema collection are valid (conforms to the syntactic rules of XML and the rules for a specified vocabulary). * * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param xPath The XPath expression. */ - selectSingleNode(xPath: string): Word.CustomXmlNode; + validate(): OfficeExtension.ClientResult; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CustomXmlNodeLoadOptions): Word.CustomXmlNode; + load(options?: Word.Interfaces.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlSchemaCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.CustomXmlNode; + load(propertyNames?: string | string[]): Word.CustomXmlSchemaCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.CustomXmlNode; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlSchemaCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlNode; + track(): Word.CustomXmlSchemaCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlNode; + untrack(): Word.CustomXmlSchemaCollection; /** * 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.CustomXmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.CustomXmlSchemaCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.CustomXmlNodeData; + toJSON(): Word.Interfaces.CustomXmlSchemaCollectionData; } /** - * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. + * Adds one or more schemas to a schema collection that can then be added to a stream in the data store and to the schema library. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - class ContentControl extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + interface CustomXmlAddSchemaOptions { /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * If provided, specifies the alias of the schema to be added to the collection. However, if the alias already exists in the Schema Library, the schema can be found using this value. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly buildingBlockGalleryContentControl: Word.BuildingBlockGalleryContentControl; + alias?: string; /** - * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * If provided, specifies the location of the schema on a disk. If this property is specified, the schema is added to the collection and to the Schema Library. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.3] */ - readonly checkboxContentControl: Word.CheckboxContentControl; + fileName?: string; /** - * Gets the data of the content control when its type is `comboBox`. It's `null` otherwise. + * If provided, specifies whether, in the case where the schema is being added to the Schema Library, the Schema Library keys should be written to the registry (`HKEY_LOCAL_MACHINE` for all users or `HKEY_CURRENT_USER` for just the current user). The property defaults to `false` and writes to `HKEY_CURRENT_USER`. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.3] */ - readonly comboBoxContentControl: Word.ComboBoxContentControl; + installForAllUsers?: boolean; /** - * Gets the collection of `ContentControl` objects in the content control. + * If provided, specifies the namespace of the schema to be added to the collection. However, if the schema already exists in the Schema Library, the schema will be retrieved from there. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - readonly contentControls: Word.ContentControlCollection; + namespaceUri?: string; + } + /** + * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class CustomXmlNodeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.CustomXmlNode[]; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly datePickerContentControl: Word.DatePickerContentControl; + getCount(): OfficeExtension.ClientResult; /** - * Gets the data of the content control when its type is `dropDownList`. It's `null` otherwise. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.9] + * @param options Provides options for which properties of the object to load. */ - readonly dropDownListContentControl: Word.DropDownListContentControl; + load(options?: Word.Interfaces.CustomXmlNodeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlNodeCollection; /** - * Gets the collection of endnotes in the content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.5] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly endnotes: Word.NoteItemCollection; + load(propertyNames?: string | string[]): Word.CustomXmlNodeCollection; /** - * Gets the collection of `Field` objects in the content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.4] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - readonly fields: Word.FieldCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlNodeCollection; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - readonly font: Word.Font; + track(): Word.CustomXmlNodeCollection; /** - * Gets the collection of footnotes in the content control. - * - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - readonly footnotes: Word.NoteItemCollection; + untrack(): Word.CustomXmlNodeCollection; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * 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.CustomXmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CustomXmlNodeCollectionData; + } + /** + * The options that define the prefix mapping and the source of the custom XML data. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface CustomXmlAppendChildNodeOptions { + /** + * If provided, specifies the base name of the element to be appended. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly groupContentControl: Word.GroupContentControl; + name?: string; /** - * Gets the collection of `InlinePicture` objects in the content control. The collection doesn't include floating images. + * If provided, specifies the namespace of the element to be appended. This property is required to append nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - readonly inlinePictures: Word.InlinePictureCollection; + namespaceUri?: string; /** - * Gets the collection of `List` objects in the content control. + * If provided, specifies the type of node to append. If the property isn't specified, it's assumed to be of type `element`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly lists: Word.ListCollection; + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; /** - * Gets the collection of `Paragraph` objects in the content control. + * If provided, specifies the value of the appended node for those nodes that allow text. If the node doesn't allow text, the property is ignored. * * @remarks - * [Api set: WordApi 1.1] - * - * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + * [Api set: WordApiDesktop 1.3] */ - readonly paragraphs: Word.ParagraphCollection; + nodeValue?: string; + } + /** + * Inserts a new node just before the context node in the tree. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface CustomXmlInsertNodeBeforeOptions { /** - * Gets the parent body of the content control. + * If provided, specifies the base name of the element to be inserted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly parentBody: Word.Body; + name?: string; /** - * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * If provided, specifies the namespace of the element to be inserted. This property is required to insert nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - readonly parentContentControl: Word.ContentControl; + namespaceUri?: string; /** - * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * If provided, specifies the context node. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly parentContentControlOrNullObject: Word.ContentControl; + nextSibling?: Word.CustomXmlNode; /** - * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * If provided, specifies the type of node to append. If the property isn't specified, it's assumed to be of type `element`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly parentTable: Word.Table; + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; /** - * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * If provided, specifies the value of the inserted node for those nodes that allow text. If the node doesn't allow text, the property is ignored. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] + */ + nodeValue?: string; + } + /** + * Inserts a new node just before the context node in the tree. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface CustomXmlInsertSubtreeBeforeOptions { + /** + * If provided, specifies the context node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nextSibling?: Word.CustomXmlNode; + } + /** + * Removes the specified child node and replaces it with a different node in the same location. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface CustomXmlReplaceChildNodeOptions { + /** + * If provided, specifies the base name of the replacement element. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + name?: string; + /** + * If provided, specifies the namespace of the replacement element. This property is required to replace nodes of {@link Word.CustomXmlNodeType | type} `element` or `attribute`; otherwise, it's ignored. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + namespaceUri?: string; + /** + * If provided, specifies the type of the replacement node. If the property isn't specified, it's assumed to be of type `element`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + /** + * If provided, specifies the value of the replacement node for those nodes that allow text. If the node doesn't allow text, the property is ignored. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nodeValue?: string; + } + /** + * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class CustomXmlNode extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly attributes: Word.CustomXmlNodeCollection; + /** + * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly childNodes: Word.CustomXmlNodeCollection; + /** + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly firstChild: Word.CustomXmlNode; + /** + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly lastChild: Word.CustomXmlNode; + /** + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly nextSibling: Word.CustomXmlNode; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly ownerPart: Word.CustomXmlPart; + /** + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly parentNode: Word.CustomXmlNode; + /** + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly previousSibling: Word.CustomXmlNode; + /** + * Gets the base name of the node without the namespace prefix, if one exists. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly baseName: string; + /** + * Gets the unique address identifier for the namespace of the node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly namespaceUri: string; + /** + * Gets the type of the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly nodeType: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + /** + * Specifies the value of the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nodeValue: string; + /** + * Specifies the text for the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + text: string; + /** + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly xpath: string; + /** + * Gets the XML representation of the current node and its children. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly xml: string; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CustomXmlNodeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CustomXmlNode): void; + /** + * Appends a single node as the last child under the context element node in the tree. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param options Optional. The options that define the node to be appended. + */ + appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions): OfficeExtension.ClientResult; + /** + * Adds a subtree as the last child under the context element node in the tree. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param xml A string representing the XML subtree. + */ + appendChildSubtree(xml: string): OfficeExtension.ClientResult; + /** + * Deletes the current node from the tree (including all of its children, if any exist). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + delete(): void; + /** + * Specifies if the current element node has child element nodes. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hasChildNodes(): OfficeExtension.ClientResult; + /** + * Inserts a new node just before the context node in the tree. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param options Optional. The options that define the node to be inserted. + */ + insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions): OfficeExtension.ClientResult; + /** + * Inserts the specified subtree into the location just before the context node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param xml A string representing the XML subtree. + * @param options Optional. The options available for inserting the subtree. + */ + insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions): OfficeExtension.ClientResult; + /** + * Removes the specified child node from the tree. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param child The child node to remove. + */ + removeChild(child: Word.CustomXmlNode): OfficeExtension.ClientResult; + /** + * Removes the specified child node and replaces it with a different node in the same location. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param oldNode The node to be replaced. + * @param options Optional. The options that define the child node which is to replace the old node. + */ + replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions): OfficeExtension.ClientResult; + /** + * Removes the specified node and replaces it with a different subtree in the same location. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param xml A string representing the new subtree. + * @param oldNode The node to be replaced. + */ + replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode): OfficeExtension.ClientResult; + /** + * Selects a collection of nodes matching an XPath expression. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param xPath The XPath expression. + */ + selectNodes(xPath: string): Word.CustomXmlNodeCollection; + /** + * Selects a single node from a collection matching an XPath expression. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param xPath The XPath expression. + */ + selectSingleNode(xPath: string): Word.CustomXmlNode; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.CustomXmlNodeLoadOptions): Word.CustomXmlNode; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.CustomXmlNode; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.CustomXmlNode; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlNode; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.CustomXmlNode; + /** + * 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.CustomXmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CustomXmlNodeData; + } + /** + * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. + * + * @remarks + * [Api set: WordApi 1.1] + */ + class ContentControl extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly buildingBlockGalleryContentControl: Word.BuildingBlockGalleryContentControl; + /** + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ + readonly checkboxContentControl: Word.CheckboxContentControl; + /** + * Gets the data of the content control when its type is `comboBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly comboBoxContentControl: Word.ComboBoxContentControl; + /** + * Gets the collection of `ContentControl` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly contentControls: Word.ContentControlCollection; + /** + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly datePickerContentControl: Word.DatePickerContentControl; + /** + * Gets the data of the content control when its type is `dropDownList`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly dropDownListContentControl: Word.DropDownListContentControl; + /** + * Gets the collection of endnotes in the content control. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly endnotes: Word.NoteItemCollection; + /** + * Gets the collection of `Field` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly fields: Word.FieldCollection; + /** + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly font: Word.Font; + /** + * Gets the collection of footnotes in the content control. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly footnotes: Word.NoteItemCollection; + /** + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly groupContentControl: Word.GroupContentControl; + /** + * Gets the collection of `InlinePicture` objects in the content control. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly inlinePictures: Word.InlinePictureCollection; + /** + * Gets the collection of `List` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly lists: Word.ListCollection; + /** + * Gets the collection of `Paragraph` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + */ + readonly paragraphs: Word.ParagraphCollection; + /** + * Gets the parent body of the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentBody: Word.Body; + /** + * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly parentContentControl: Word.ContentControl; + /** + * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentContentControlOrNullObject: Word.ContentControl; + /** + * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentTable: Word.Table; + /** + * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] */ readonly parentTableCell: Word.TableCell; /** @@ -99288,6 +100208,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ attachedTemplate: Word.Template; + /** + * Gets a `Shape` object that represents the background image for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly background: Word.Shape; /** * Returns a `Bibliography` object that represents the bibliography references contained within the document. * @@ -99303,1867 +100230,1754 @@ declare namespace Word { */ readonly body: Word.Body; /** - * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Returns a `BookmarkCollection` object that represents all the bookmarks in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - readonly contentControls: Word.ContentControlCollection; + readonly bookmarks: Word.BookmarkCollection; /** - * Gets the custom XML parts in the document. + * Gets a `DocumentProperties` object that represents all the built-in document properties for the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly customXmlParts: Word.CustomXmlPartCollection; + readonly builtInDocumentProperties: Word.DocumentProperties; /** - * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. + * Gets the `RangeScopedCollection` object that represents all the characters in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection; + readonly characters: Word.RangeScopedCollection; /** - * Returns a `FrameCollection` object that represents all the frames in the document. + * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly frames: Word.FrameCollection; + readonly coauthoring: Word.Coauthoring; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * Gets a `CommentCollection` object that represents all the comments in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly hyperlinks: Word.HyperlinkCollection; + readonly comments: Word.CommentCollection; /** - * Returns a `PageSetup` object that's associated with the document. + * Gets a `Range` object that represents the main document story. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly pageSetup: Word.PageSetup; + readonly content: Word.Range; /** - * Gets the properties of the document. + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - readonly properties: Word.DocumentProperties; + readonly contentControls: Word.ContentControlCollection; /** - * Gets the collection of `Section` objects in the document. + * Gets a `DocumentProperties` collection that represents all the custom document properties for the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - readonly sections: Word.SectionCollection; + readonly customDocumentProperties: Word.DocumentProperties; /** - * Gets the add-in's settings in the document. + * Gets the custom XML parts in the document. * * @remarks * [Api set: WordApi 1.4] */ - readonly settings: Word.SettingCollection; + readonly customXmlParts: Word.CustomXmlPartCollection; /** - * Gets the collection of `Word.Window` objects for the document. + * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - readonly windows: Word.WindowCollection; + readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection; /** - * Specifies if automatic hyphenation is turned on for the document. + * Gets a `FieldCollection` object that represents all the fields in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - autoHyphenation: boolean; + readonly fields: Word.FieldCollection; /** - * Specifies if the edits in the document are automatically saved. + * Returns a `FrameCollection` object that represents all the frames in the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - autoSaveOn: boolean; + readonly frames: Word.FrameCollection; /** - * Specifies the ChangeTracking mode. + * Gets a `RangeCollection` object that represents the sentences that failed the grammar check in the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + readonly grammaticalErrors: Word.RangeCollection; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - consecutiveHyphensLimit: number; + readonly hyperlinks: Word.HyperlinkCollection; /** - * Specifies whether words in all capital letters can be hyphenated. + * Returns an `IndexCollection` object that represents all the indexes in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - hyphenateCaps: boolean; + readonly indexes: Word.IndexCollection; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Gets a `ParagraphCollection` object that represents all the numbered paragraphs in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageDetected: boolean; + readonly listParagraphs: Word.ParagraphCollection; /** - * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. + * Returns a `ListTemplateCollection` object that represents all the list templates in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - readonly saved: boolean; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Document): void; + readonly listTemplates: Word.ListTemplateCollection; /** - * Adds a style into the document by name and type. + * Gets a `ListCollection` object that contains all the formatted lists in the document. * * @remarks - * [Api set: WordApi 1.5] - * - * @param name A string representing the style name. - * @param type The style type, including character, list, paragraph, or table. + * [Api set: WordApiDesktop 1.4] */ - addStyle(name: string, type: Word.StyleType): Word.Style; + readonly lists: Word.ListCollection; /** - * Adds a style into the document by name and type. + * Returns a `PageSetup` object that's associated with the document. * * @remarks - * [Api set: WordApi 1.5] - * - * @param name A string representing the style name. - * @param type The style type, including character, list, paragraph, or table. + * [Api set: WordApiDesktop 1.3] */ - addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; + readonly pageSetup: Word.PageSetup; /** - * Closes the current document. - - Note: This API isn't supported in Word on the web. + * Gets a `ParagraphCollection` object that represents all the paragraphs in the document. * * @remarks - * [Api set: WordApi 1.5] - * - * @param closeBehavior Optional. The close behavior must be `save` or `skipSave`. Default value is `save`. + * [Api set: WordApiDesktop 1.4] */ - close(closeBehavior?: Word.CloseBehavior): void; + readonly paragraphs: Word.ParagraphCollection; /** - * Closes the current document. - - Note: This API isn't supported in Word on the web. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi 1.5] - * - * @param closeBehavior Optional. The close behavior must be `save` or `skipSave`. Default value is `save`. + * [Api set: WordApi 1.3] */ - close(closeBehavior?: "Save" | "SkipSave"): void; + readonly properties: Word.DocumentProperties; /** - * Displays revision marks that indicate where the specified document differs from another document. + * Gets a `ReadabilityStatisticCollection` object that represents the readability statistics for the document. * * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param filePath The path of the document with which the specified document is compared. - * @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document. + * [Api set: WordApiDesktop 1.4] */ - compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void; + readonly readabilityStatistics: Word.ReadabilityStatisticCollection; /** - * Displays revision marks that indicate where the specified document differs from another document. + * Gets the collection of revisions that represents the tracked changes in the document. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param base64File The Base64-encoded content of the document with which the specified document is compared. - * @param documentCompareOptions Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `compareTargetSelected` in this API. + * [Api set: WordApiDesktop 1.4] */ - compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void; + readonly revisions: Word.RevisionCollection; /** - * Deletes a bookmark, if it exists, from the document. + * Gets the collection of `Section` objects in the document. * * @remarks - * [Api set: WordApi 1.4] - * - * @param name The case-insensitive bookmark name. + * [Api set: WordApi 1.1] */ - deleteBookmark(name: string): void; + readonly sections: Word.SectionCollection; /** - * Analyzes the document text to determine the language. + * Returns a `Selection` object that represents the current selection in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - detectLanguage(): void; + readonly selection: Word.Selection; /** - * Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found. + * Gets the `RangeScopedCollection` object that represents all the sentences in the document. * * @remarks - * [Api set: WordApi 1.7] - * - * @param id The ID of the annotation to get. + * [Api set: WordApiDesktop 1.4] */ - getAnnotationById(id: string): Word.Annotation; + readonly sentences: Word.RangeScopedCollection; /** - * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. + * Gets the add-in's settings in the document. * * @remarks * [Api set: WordApi 1.4] - * - * @param name The case-insensitive bookmark name. */ - getBookmarkRange(name: string): Word.Range; + readonly settings: Word.SettingCollection; /** - * Gets a bookmark's range. If the bookmark doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets a `RangeCollection` object that represents the words identified as spelling errors in the document. * * @remarks - * [Api set: WordApi 1.4] - * - * @param name The case-insensitive bookmark name. + * [Api set: WordApiDesktop 1.4] */ - getBookmarkRangeOrNullObject(name: string): Word.Range; + readonly spellingErrors: Word.RangeCollection; /** - * Gets the currently supported content controls in the document. + * Gets a `RangeCollection` object that represents all the stories in the document. * * @remarks - * [Api set: WordApi 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options Optional. Options that define which content controls are returned. + * [Api set: WordApiDesktop 1.4] */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + readonly storyRanges: Word.RangeCollection; /** - * Gets the document's endnotes in a single body. + * Gets a `StyleCollection` for the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - getEndnoteBody(): Word.Body; + readonly styles: Word.StyleCollection; /** - * Gets the document's footnotes in a single body. + * Returns a `TableOfAuthoritiesCategoryCollection` object that represents the available table of authorities categories in the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - getFootnoteBody(): Word.Body; + readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection; /** - * Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty. + * Gets a `TableCollection` object that represents all the tables in the document. * * @remarks - * [Api set: WordApi 1.6] - * - * @param id Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. + * [Api set: WordApiDesktop 1.4] */ - getParagraphByUniqueLocalId(id: string): Word.Paragraph; + readonly tables: Word.TableCollection; /** - * Gets the current selection of the document. Multiple selections aren't supported. + * Returns a `TableOfAuthoritiesCollection` object that represents all the tables of authorities in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - getSelection(): Word.Range; + readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection; /** - * Gets a `StyleCollection` object that represents the whole style set of the document. + * Returns a `TableOfContentsCollection` object that represents all the tables of contents in the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - getStyles(): Word.StyleCollection; + readonly tablesOfContents: Word.TableOfContentsCollection; /** - * Import styles from a JSON-formatted string. + * Returns a `TableOfFiguresCollection` object that represents all the tables of figures in the document. * * @remarks - * [Api set: WordApi 1.6] - * - * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. - * - * @param stylesJson A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. The default value is `ignore`. + * [Api set: WordApiDesktop 1.4] */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + readonly tablesOfFigures: Word.TableOfFiguresCollection; /** - * Import styles from a JSON-formatted string. + * Gets the `WebSettings` object for webpage-related attributes. * * @remarks - * [Api set: WordApi 1.6] - * - * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. - * - * @param stylesJson A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. The default value is `ignore`. + * [Api set: WordApiDesktop 1.4] */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult; + readonly webSettings: Word.WebSettings; /** - * Inserts a document into the target document at a specific location with additional properties. - Headers, footers, watermarks, and other section properties are copied by default. + * Gets the collection of `Word.Window` objects for the document. * * @remarks - * [Api set: WordApi 1.5] - * - * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. - * - * @param base64File The Base64-encoded content of a .docx file. - * @param insertLocation The value must be `replace`, `start`, or `end`. - * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. + * [Api set: WordApiDesktop 1.2] */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + readonly windows: Word.WindowCollection; /** - * Initiates manual hyphenation of a document, one line at a time. + * Gets the `RangeScopedCollection` object that represents each word in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - manualHyphenation(): void; + readonly words: Word.RangeScopedCollection; /** - * Saves the document. + * Gets the name of the active theme and formatting options. * * @remarks - * [Api set: WordApi 1.1] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. - * - * @param saveBehavior Optional. The save behavior must be `save` or `prompt`. Default value is `save`. - * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApiDesktop 1.4] */ - save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; + readonly activeTheme: string; /** - * Saves the document. + * Gets the display name of the active theme. * * @remarks - * [Api set: WordApi 1.1] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. - * - * @param saveBehavior Optional. The save behavior must be `save` or `prompt`. Default value is `save`. - * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApiDesktop 1.4] */ - save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; + readonly activeThemeDisplayName: string; /** - * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of `Range` objects. + * Gets whether Word encrypts file properties for password-protected documents. * * @remarks - * [Api set: WordApi 1.7] - * - * @param searchText The text to search for. - * @param searchOptions Optional. Options that define how the search is performed. + * [Api set: WordApiDesktop 1.4] */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + readonly areFilePropertiesPasswordEncrypted: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether grammatical errors are marked by a wavy green line in the document. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document; + areGrammaticalErrorsShown: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether to use the default math settings when creating new equations. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.Document; + areMathDefaultsUsed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether to disable features introduced after a specified version. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Document; + areNewerFeaturesDisabled: boolean; /** - * Occurs when the user clicks an annotation (or selects it using **Alt+Down**). + * Specifies whether Microsoft Word underlines spelling errors in the document. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApiDesktop 1.4] */ - readonly onAnnotationClicked: OfficeExtension.EventHandlers; + areSpellingErrorsShown: boolean; /** - * Occurs when the user hovers the cursor over an annotation. + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApiDesktop 1.4] */ - readonly onAnnotationHovered: OfficeExtension.EventHandlers; + areStylesUpdatedOnOpen: boolean; /** - * Occurs when the user adds one or more annotations. + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApiDesktop 1.4] */ - readonly onAnnotationInserted: OfficeExtension.EventHandlers; + areTrueTypeFontsEmbedded: boolean; /** - * Occurs when the user performs an action in an annotation pop-up menu. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks - * [Api set: WordApi 1.8] - * - * @eventproperty + * [Api set: WordApiDesktop 1.3] */ - readonly onAnnotationPopupAction: OfficeExtension.EventHandlers; + autoHyphenation: boolean; /** - * Occurs when the user deletes one or more annotations. + * Specifies if the edits in the document are automatically saved. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApiDesktop 1.3] */ - readonly onAnnotationRemoved: OfficeExtension.EventHandlers; + autoSaveOn: boolean; /** - * Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi 1.5] - * - * @eventproperty + * [Api set: WordApi 1.4] */ - readonly onContentControlAdded: OfficeExtension.EventHandlers; + changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; /** - * Occurs when the user adds new paragraphs. + * Gets the code name for the document. * * @remarks - * [Api set: WordApi 1.6] - * - * @eventproperty + * [Api set: WordApiDesktop 1.4] */ - readonly onParagraphAdded: OfficeExtension.EventHandlers; + readonly codeName: string; /** - * Occurs when the user changes paragraphs. + * Gets the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApi 1.6] - * - * @eventproperty + * [Api set: WordApiDesktop 1.4] */ - readonly onParagraphChanged: OfficeExtension.EventHandlers; + readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current"; /** - * Occurs when the user deletes paragraphs. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks - * [Api set: WordApi 1.6] - * - * @eventproperty + * [Api set: WordApiDesktop 1.3] */ - readonly onParagraphDeleted: OfficeExtension.EventHandlers; + consecutiveHyphensLimit: number; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets a random number that Word assigns to changes in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.Document; + readonly currentRsid: number; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the interval (in points) between the default tab stops in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.Document; - /** - * 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.Document` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.DocumentData; - } - /** - * The `DocumentCreated` object is the top level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class DocumentCreated extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + defaultTabStop: number; /** - * Gets the `Body` object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly body: Word.Body; + defaultTargetFrame: string; /** - * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly contentControls: Word.ContentControlCollection; + doNotEmbedSystemFonts: boolean; /** - * Gets the custom XML parts in the document. + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly customXmlParts: Word.CustomXmlPartCollection; + encryptionProvider: string; /** - * Gets the properties of the document. + * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly properties: Word.DocumentProperties; + farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets the collection of `Section` objects in the document. + * Specifies the line break control level. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly sections: Word.SectionCollection; + farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Gets the add-in's settings in the document. + * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly settings: Word.SettingCollection; + formattingIsNextLevelShown: boolean; /** - * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. + * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly saved: boolean; + formattingIsUserStyleNameShown: boolean; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Gets the name of a document, including the path. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DocumentCreated): void; + readonly fullName: string; /** - * Adds a style into the document by name and type. + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * @param name A string representing the style name. - * @param type The style type, including character, list, paragraph, or table. + * [Api set: WordApiDesktop 1.4] */ - addStyle(name: string, type: Word.StyleType): Word.Style; + gridDistanceHorizontal: number; /** - * Adds a style into the document by name and type. + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * @param name A string representing the style name. - * @param type The style type, including character, list, paragraph, or table. + * [Api set: WordApiDesktop 1.4] */ - addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; + gridDistanceVertical: number; /** - * Deletes a bookmark, if it exists, from the document. + * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name The case-insensitive bookmark name. + * [Api set: WordApiDesktop 1.4] */ - deleteBookmark(name: string): void; + gridIsOriginFromMargin: boolean; /** - * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. + * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name The case-insensitive bookmark name. + * [Api set: WordApiDesktop 1.4] */ - getBookmarkRange(name: string): Word.Range; + gridOriginHorizontal: number; /** - * Gets a bookmark's range. If the bookmark doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Specifies the vertical origin point for the invisible grid. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + * [Api set: WordApiDesktop 1.4] */ - getBookmarkRangeOrNullObject(name: string): Word.Range; + gridOriginVertical: number; /** - * Gets the currently supported content controls in the document. + * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options Optional. Options that define which content controls are returned. + * [Api set: WordApiDesktop 1.4] */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + gridSpaceBetweenHorizontalLines: number; /** - * Gets a `StyleCollection` object that represents the whole style set of the document. + * Specifies the interval for vertical character gridlines in print layout view. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] + * [Api set: WordApiDesktop 1.4] */ - getStyles(): Word.StyleCollection; + gridSpaceBetweenVerticalLines: number; /** - * Inserts a document into the target document at a specific location with additional properties. - Headers, footers, watermarks, and other section properties are copied by default. + * Gets whether a password is required to open the document. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. - * - * @param base64File The Base64-encoded content of a .docx file. - * @param insertLocation The value must be `replace`, `start`, or `end`. - * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. + * [Api set: WordApiDesktop 1.4] */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + readonly hasPassword: boolean; /** - * Opens the document. + * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - open(): void; + readonly hasVbProject: boolean; /** - * Saves the document. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. - * - * @param saveBehavior Optional. `DocumentCreated` only supports `save`. - * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApiDesktop 1.3] */ - save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; + hyphenateCaps: boolean; /** - * Saves the document. + * Specifies the width of the hyphenation zone, in points. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. - * - * @param saveBehavior Optional. `DocumentCreated` only supports `save`. - * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApiDesktop 1.4] */ - save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; + hyphenationZone: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether automatic formatting options override formatting restrictions. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated; + isAutoFormatOverrideOn: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether charts in the active document use cell-reference data-point tracking. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.DocumentCreated; + isChartDataPointTracked: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the compatibility option specified by the `type` property is enabled. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.DocumentCreated; + isCompatible: boolean; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies whether the document is final. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.DocumentCreated; + isFinal: boolean; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.DocumentCreated; - /** - * 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.DocumentCreated` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentCreatedData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.DocumentCreatedData; - } - /** - * Represents document properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class DocumentProperties extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + isFontsSubsetSaved: boolean; /** - * Gets the collection of custom properties of the document. + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly customProperties: Word.CustomPropertyCollection; + isFormsDataPrinted: boolean; /** - * Gets the application name of the document. + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly applicationName: string; + isFormsDataSaved: boolean; /** - * Specifies the author of the document. + * Specifies whether a grammar check has been run on the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - author: string; + isGrammarChecked: boolean; /** - * Specifies the category of the document. + * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - category: string; + readonly isInAutoSave: boolean; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Gets whether the document is in form design mode. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - comments: string; + readonly isInFormsDesign: boolean; /** - * Specifies the company of the document. + * Specifies whether Word kerns half-width Latin characters and punctuation marks. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - company: string; + isKerningByAlgorithm: boolean; /** - * Gets the creation date of the document. + * Specifies whether to embed speech and handwriting data. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly creationDate: Date; + isLinguisticDataEmbedded: boolean; /** - * Specifies the format of the document. + * Gets whether this document is a master document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - format: string; + readonly isMasterDocument: boolean; /** - * Specifies the keywords of the document. + * Specifies whether Word optimizes the document for Word 97. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - keywords: string; + isOptimizedForWord97: boolean; /** - * Gets the last author of the document. + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly lastAuthor: string; + isPostScriptPrintedOverText: boolean; /** - * Gets the last print date of the document. + * Specifies whether users can change the Quick Style set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly lastPrintDate: Date; + isQuickStyleSetLocked: boolean; /** - * Gets the last save time of the document. + * Gets whether changes to the document cannot be saved to the original document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly lastSaveTime: Date; + readonly isReadOnly: boolean; /** - * Specifies the manager of the document. + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - manager: string; + isReadOnlyRecommended: boolean; /** - * Gets the revision number of the document. + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly revisionNumber: string; + isSnappedToGrid: boolean; /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly security: number; + isSnappedToShapes: boolean; /** - * Specifies the subject of the document. + * Specifies whether spelling has been checked throughout the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - subject: string; + isSpellingChecked: boolean; /** - * Gets the template of the document. + * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly template: string; + isStyleEnforced: boolean; /** - * Specifies the title of the document. + * Gets whether this document is a subdocument of a master document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - title: string; + readonly isSubdocument: boolean; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies whether users can change the document theme. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DocumentProperties): void; + isThemeLocked: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the document was created or opened by the user. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties; + isUserControl: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether the VBA project is digitally signed. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.DocumentProperties; + readonly isVbaSigned: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether the document is protected with a write password. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.DocumentProperties; + readonly isWriteReserved: boolean; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the character spacing adjustment. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.DocumentProperties; + justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the format type that Microsoft Word uses when automatically formatting the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.DocumentProperties; - /** - * 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.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.DocumentPropertiesData; - } - /** - * The data specific to content controls of type `dropDownList`. - * - * @remarks - * [Api set: WordApi 1.9] - */ - class DropDownListContentControl extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; /** - * Gets the collection of list items in the dropdown list content control. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.3] */ - readonly listItems: Word.ContentControlListItemCollection; + languageDetected: boolean; /** - * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object. + * Specifies the kinsoku characters after which Word will not break a line. * * @remarks - * [Api set: WordApi 1.9] - * - * @param displayText Display text of the list item. - * @param value Optional. Value of the list item. - * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + * [Api set: WordApiDesktop 1.4] */ - addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + noLineBreakAfter: string; /** - * Deletes all list items in this dropdown list content control. + * Specifies the kinsoku characters before which Word will not break a line. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.4] */ - deleteAllListItems(): void; + noLineBreakBefore: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the encoding used to open the document. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.DropDownListContentControl; + readonly openEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the title of the original document after legal-blackline comparison. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.DropDownListContentControl; + readonly originalDocumentTitle: string; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Sets a password that must be supplied to open the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.DropDownListContentControl; + password: string; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets the algorithm used for password encryption. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.DropDownListContentControl; - /** - * 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.DropDownListContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropDownListContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.DropDownListContentControlData; - } - /** - * The data specific to content controls of type `comboBox`. - * - * @remarks - * [Api set: WordApi 1.9] - */ - class ComboBoxContentControl extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + readonly passwordEncryptionAlgorithm: string; /** - * Gets the collection of list items in the combo box content control. + * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.4] */ - readonly listItems: Word.ContentControlListItemCollection; + readonly passwordEncryptionKeyLength: number; /** - * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object. + * Gets the name of the password encryption provider. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.4] + */ + readonly passwordEncryptionProvider: string; + /** + * Gets the disk or the web path to the document (excludes the document name). * - * @param displayText Display text of the list item. - * @param value Optional. Value of the list item. - * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + readonly path: string; /** - * Deletes all list items in this combo box content control. + * Specifies whether revision marks are printed with the document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.4] */ - deleteAllListItems(): void; + printRevisions: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the protection type for the document. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.ComboBoxContentControl; + readonly protectionType: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the width of pages in reading layout view when frozen. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ComboBoxContentControl; + readingLayoutSizeX: number; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the height of pages in reading layout view when frozen. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.ComboBoxContentControl; + readingLayoutSizeY: number; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies whether pages in reading layout view are frozen for handwritten markup. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.ComboBoxContentControl; + readingModeIsLayoutFrozen: boolean; /** - * 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.ComboBoxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ComboBoxContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.ComboBoxContentControlData; - } - /** - * Represents a field. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. - */ - class Field extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + * Specifies whether Word removes user information upon saving. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + removePersonalInformationOnSave: boolean; /** - * Gets the parent body of the field. + * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly parentBody: Word.Body; + readonly revisedDocumentTitle: string; /** - * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies the encoding used when saving the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly parentContentControl: Word.ContentControl; + saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the file format of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly parentContentControlOrNullObject: Word.ContentControl; + readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"; /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - readonly parentTable: Word.Table; + readonly saved: boolean; /** - * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Specifies the encoding for saving as encoded text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly parentTableCell: Word.TableCell; + textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Specifies how Word marks line and paragraph breaks in text files. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly parentTableCellOrNullObject: Word.TableCell; + textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; /** - * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Specifies whether to track formatting changes when change tracking is on. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly parentTableOrNullObject: Word.Table; + trackFormatting: boolean; /** - * Gets the field's result data. + * Specifies whether to mark moved text when Track Changes is on. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly result: Word.Range; + trackMoves: boolean; /** - * Specifies the field's code instruction. + * Specifies whether changes are tracked in the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] + */ + trackRevisions: boolean; + /** + * Specifies whether to remove or store date and time metadata for tracked changes. * - * Note: The ability to set the code was introduced in WordApi 1.5. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - code: string; + trackedChangesAreDateAndTimeRemoved: boolean; /** - * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. + * Gets the document type (template or document). * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - data: string; + readonly type: Word.DocumentType | "Document" | "Template" | "Frameset"; /** - * Gets the field's kind. + * Sets a password for saving changes to the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly kind: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + writePassword: string; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - locked: boolean; + xmlAreAdvancedErrorsShown: boolean; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - showCodes: boolean; + xmlIsXsltUsedWhenSaving: boolean; /** - * Gets the field's type. + * Specifies the path and file name for the XSLT to apply when saving a document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly type: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; + xmlSaveThroughXslt: string; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.FieldUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Field): void; + set(properties: Word.Document): void; /** - * Deletes the field. + * Accepts all tracked changes in the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - delete(): void; + acceptAllRevisions(): void; /** - * Gets the next field. Throws an `ItemNotFound` error if this field is the last one. + * Accepts all revisions in the document that are displayed on the screen. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - getNext(): Word.Field; + acceptAllRevisionsShown(): void; /** - * Gets the next field. If this field is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Activates the document so that it becomes the active document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - getNextOrNullObject(): Word.Field; + activate(): void; /** - * Selects the field. + * Adds a style into the document by name and type. * * @remarks * [Api set: WordApi 1.5] * - * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ - select(selectionMode?: Word.SelectionMode): void; + addStyle(name: string, type: Word.StyleType): Word.Style; /** - * Selects the field. + * Adds a style into the document by name and type. * * @remarks * [Api set: WordApi 1.5] * - * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ - select(selectionMode?: "Select" | "Start" | "End"): void; + addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; /** - * Updates the field. + * Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - updateResult(): void; + addToFavorites(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Applies the specified Quick Style set to the document. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param style The style set to apply. */ - load(options?: Word.Interfaces.FieldLoadOptions): Word.Field; + applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Applies the specified Quick Style set to the document. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param style The style set to apply. */ - load(propertyNames?: string | string[]): Word.Field; + applyQuickStyleSet(style: "SessionStart" | "Template"): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Applies the specified theme to this document. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param name The name of the theme. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Field; + applyTheme(name: string): void; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Automatically formats the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.Field; + autoFormat(): void; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Returns `true` if Microsoft Word can check in the document to a server. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * @returns `true` if the document can be checked in; otherwise, `false`. */ - untrack(): Word.Field; - /** - * 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.Field` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.FieldData; - } - /** - * Contains a collection of {@link Word.Field} objects. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. - */ - class FieldCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.Field[]; + canCheckin(): OfficeExtension.ClientResult; /** - * Gets the first field in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Searches all text in a Japanese language document and displays instances where character usage is inconsistent for the same words. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - getFirst(): Word.Field; + checkConsistencyJapanese(): void; /** - * Gets the first field in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Begins a spelling and grammar check for the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - getFirstOrNullObject(): Word.Field; + checkGrammar(): void; /** - * Gets the `FieldCollection` object including the specified types of fields. + * Closes the current document. + + Note: This API isn't supported in Word on the web. * * @remarks * [Api set: WordApi 1.5] * - * @param types An array of field types. + * @param closeBehavior Optional. The close behavior must be `save` or `skipSave`. Default value is `save`. */ - getByTypes(types: Word.FieldType[]): Word.FieldCollection; + close(closeBehavior?: Word.CloseBehavior): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Closes the current document. + + Note: This API isn't supported in Word on the web. * - * @param options Provides options for which properties of the object to load. - */ - load(options?: Word.Interfaces.FieldCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FieldCollection; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * @remarks + * [Api set: WordApi 1.5] * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @param closeBehavior Optional. The close behavior must be `save` or `skipSave`. Default value is `save`. */ - load(propertyNames?: string | string[]): Word.FieldCollection; + close(closeBehavior?: "Save" | "SkipSave"): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Switches the document from print preview to the previous view. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection; + closePrintPreview(): void; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Displays revision marks that indicate where the specified document differs from another document. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + * + * @param filePath The path of the document with which the specified document is compared. + * @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document. */ - track(): Word.FieldCollection; + compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Displays revision marks that indicate where the specified document differs from another document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param base64File The Base64-encoded content of the document with which the specified document is compared. + * @param documentCompareOptions Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `compareTargetSelected` in this API. */ - untrack(): Word.FieldCollection; - /** - * 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.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.FieldCollectionData; - } - /** - * Represents a font. - * - * @remarks - * [Api set: WordApi 1.1] - */ - class Font extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * Converts the file to the newest format and enables all features. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly borders: Word.BorderUniversalCollection; + convert(): void; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Converts automatic hyphens to manual hyphens. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly fill: Word.FillFormat; + convertAutoHyphens(): void; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Changes the list numbers and {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | LISTNUM fields} in the document to text. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param numberType Optional. The type of numbering to convert. */ - readonly glow: Word.GlowFormat; + convertNumbersToText(numberType?: Word.NumberType): void; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Changes the list numbers and {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | LISTNUM fields} in the document to text. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param numberType Optional. The type of numbering to convert. */ - readonly line: Word.LineFormat; + convertNumbersToText(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Reconverts a Vietnamese document to Unicode using a code page other than the default. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param codePageOrigin The code page to use. */ - readonly reflection: Word.ReflectionFormat; + convertVietnameseDocument(codePageOrigin: number): void; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Copies styles from the specified template to the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param StyleTemplate The template to copy styles from. */ - readonly textColor: Word.ColorFormat; + copyStylesFromTemplate(StyleTemplate: string): void; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Deletes all comments from the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly textShadow: Word.ShadowFormat; + deleteAllComments(): void; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Deletes all revisions in the document that are displayed on the screen. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly threeDimensionalFormat: Word.ThreeDimensionalFormat; + deleteAllCommentsShown(): void; /** - * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * Deletes all handwritten ink annotations in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - allCaps: boolean; + deleteAllInkAnnotations(): void; /** - * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. + * Deletes a bookmark, if it exists, from the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] + * + * @param name The case-insensitive bookmark name. */ - bold: boolean; + deleteBookmark(name: string): void; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. + * Analyzes the document text to determine the language. * * @remarks * [Api set: WordApiDesktop 1.3] */ - boldBidirectional: boolean; + detectLanguage(): void; /** - * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. + * Decreases the font size of text just enough so that the document page count drops by one. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - color: string; + fitToPages(): void; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Fixes the layout of the document in Web view. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - colorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + freezeLayout(): void; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.7] + * + * @param id The ID of the annotation to get. */ - colorIndexBidirectional: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + getAnnotationById(id: string): Word.Annotation; /** - * Specifies whether contextual alternates are enabled for the font. + * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] + * + * @param name The case-insensitive bookmark name. */ - contextualAlternates: boolean; + getBookmarkRange(name: string): Word.Range; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Gets a bookmark's range. If the bookmark doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] + * + * @param name The case-insensitive bookmark name. */ - diacriticColor: string; + getBookmarkRangeOrNullObject(name: string): Word.Range; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Gets the currently supported content controls in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options Optional. Options that define which content controls are returned. */ - disableCharacterSpaceGrid: boolean; + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. + * Returns an array of items that can be cross-referenced based on the specified cross-reference type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param referenceType The type of reference. */ - doubleStrikeThrough: boolean; + getCrossReferenceItems(referenceType: Word.ReferenceType): OfficeExtension.ClientResult; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Returns an array of items that can be cross-referenced based on the specified cross-reference type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param referenceType The type of reference. */ - emboss: boolean; + getCrossReferenceItems(referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"): OfficeExtension.ClientResult; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Gets the document's endnotes in a single body. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + getEndnoteBody(): Word.Body; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Gets the document's footnotes in a single body. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - engrave: boolean; + getFootnoteBody(): Word.Body; /** - * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. + * Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] + * + * @param id Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. */ - hidden: boolean; + getParagraphByUniqueLocalId(id: string): Word.Paragraph; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to `null`. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Gets the current selection of the document. Multiple selections aren't supported. * * @remarks * [Api set: WordApi 1.1] */ - highlightColor: string; + getSelection(): Word.Range; /** - * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. + * Gets a `StyleCollection` object that represents the whole style set of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - italic: boolean; + getStyles(): Word.StyleCollection; /** - * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. + * Import styles from a JSON-formatted string. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] + * + * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. + * + * @param stylesJson A JSON-formatted string representing the styles. + * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. The default value is `ignore`. */ - italicBidirectional: boolean; + importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Import styles from a JSON-formatted string. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] + * + * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. + * + * @param stylesJson A JSON-formatted string representing the styles. + * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. The default value is `ignore`. */ - kerning: number; + importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult; /** - * Specifies the ligature setting for the `Font` object. + * Inserts a document into the target document at a specific location with additional properties. + Headers, footers, watermarks, and other section properties are copied by default. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] + * + * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. + * + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. + * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. */ - ligature: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; /** - * Specifies the name of the font. + * Locks the file on the server preventing anyone else from editing it. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - name: string; + lockServerFile(): void; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Sets the compatibility options. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nameAscii: string; + makeCompatibilityDefault(): void; /** - * Specifies the font name in a right-to-left language document. + * Initiates manual hyphenation of a document, one line at a time. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nameBidirectional: string; + manualHyphenation(): void; /** - * Specifies the East Asian font name. + * Posts the document to a public folder in Microsoft Exchange. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nameFarEast: string; + post(): void; /** - * Specifies the font used for characters with codes from 128 through 255. + * Opens PowerPoint with the Word document loaded. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nameOther: string; + presentIt(): void; /** - * Specifies the number form setting for an OpenType font. + * Switches the view to print preview. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - numberForm: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + printPreview(): void; /** - * Specifies the number spacing setting for the font. + * Redoes the last action that was undone (reverses the `undo` method). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param times Optional. The number of actions to redo. + * @returns `true` if the actions were redone successfully; otherwise, `false`. */ - numberSpacing: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + redo(times?: number): OfficeExtension.ClientResult; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Rejects all tracked changes in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - outline: boolean; + rejectAllRevisions(): void; /** - * Specifies the position of text (in points) relative to the base line. + * Rejects all revisions in the document that are displayed on the screen. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - position: number; + rejectAllRevisionsShown(): void; /** - * Specifies the scaling percentage applied to the font. + * Reloads a cached document by resolving the hyperlink to the document and downloading it. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - scaling: number; + reload(): void; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Reloads the document based on an HTML document, using the document encoding. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param encoding The encoding to use. */ - shadow: boolean; + reloadAs(encoding: Word.DocumentEncoding): void; /** - * Specifies the font size in points. + * Reloads the document based on an HTML document, using the document encoding. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param encoding The encoding to use. */ - size: number; + reloadAs(encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"): void; /** - * Specifies the font size in points for right-to-left text. + * Removes sensitive information, properties, comments, and other metadata from the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param removeDocInfoType The type of document info to remove. */ - sizeBidirectional: number; + removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void; /** - * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * Removes sensitive information, properties, comments, and other metadata from the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param removeDocInfoType The type of document info to remove. */ - smallCaps: boolean; + removeDocumentInformation(removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"): void; /** - * Specifies the spacing between characters. + * Purges the document of locked styles when formatting restrictions have been applied in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spacing: number; + removeLockedStyles(): void; /** - * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. + * Removes numbers or bullets from the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param numberType Optional. The type of numbering to remove. */ - strikeThrough: boolean; + removeNumbers(numberType?: Word.NumberType): void; /** - * Specifies the stylistic set for the font. + * Removes numbers or bullets from the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param numberType Optional. The type of numbering to remove. */ - stylisticSet: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + removeNumbers(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. + * Removes the active theme from the current document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - subscript: boolean; + removeTheme(): void; /** - * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. + * Repaginates the entire document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - superscript: boolean; + repaginate(): void; /** - * Specifies the font's underline type. `none` if the font isn't underlined. + * Clears all form fields in the document, preparing the form to be filled in again. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + resetFormFields(): void; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Returns the document to the last saved reading position. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - underlineColor: string; + returnToLastReadPosition(): OfficeExtension.ClientResult; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Runs an auto macro that's stored in the document. If the specified auto macro doesn't exist, nothing happens. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param autoMacro The auto macro to run. */ - set(properties: Interfaces.FontUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Font): void; + runAutoMacro(autoMacro: Word.AutoMacro): void; /** - * Decreases the font size to the next available size. + * Runs an auto macro that's stored in the document. If the specified auto macro doesn't exist, nothing happens. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param autoMacro The auto macro to run. */ - decreaseFontSize(): void; + runAutoMacro(autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"): void; /** - * Increases the font size to the next available size. + * Saves the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. + * + * @param saveBehavior Optional. The save behavior must be `save` or `prompt`. Default value is `save`. + * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ - increaseFontSize(): void; + save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; /** - * Removes manual character formatting. + * Saves the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. + * + * @param saveBehavior Optional. The save behavior must be `save` or `prompt`. Default value is `save`. + * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ - reset(): void; + save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; /** - * Sets the specified font formatting as the default for the active document and all new documents based on the active template. + * Saves the group of quick styles currently in use. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param fileName The name of the file to save. */ - setAsTemplateDefault(): void; + saveAsQuickStyleSet(fileName: string): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of `Range` objects. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.7] + * + * @param searchText The text to search for. + * @param searchOptions Optional. Options that define how the search is performed. */ - load(options?: Word.Interfaces.FontLoadOptions): Word.Font; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Selects the contents of the document. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.Font; + select(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns all content controls with the specified tag. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param tag The tag value to filter content controls. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Font; + selectContentControlsByTag(tag: string): Word.ContentControlCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Returns a `ContentControlCollection` object that represents all the content controls in the document with the specified title. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param title The title of the content controls. */ - track(): Word.Font; + selectContentControlsByTitle(title: string): Word.ContentControlCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Returns a `ContentControlCollection` object that represents all content controls in the document that are linked to the specific custom XML node. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param node The custom XML node. */ - untrack(): Word.Font; + selectLinkedControls(node: Word.CustomXmlNode): Word.ContentControlCollection; /** - * 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.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.FontData; - } - /** - * Represents a hyperlink in a Word document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class Hyperlink extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + * Returns an `XmlNodeCollection` object that represents all the nodes that match the XPath parameter in the order in which they appear in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param xPath The XPath expression. + * @param options Optional. Configuration options for the nodes selection. + */ + selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Returns an `XmlNode` object that represents the first node that matches the XPath parameter in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param xPath The XPath expression. + * @param options Optional. Configuration options for the node selection. */ - readonly range: Word.Range; + selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Returns a `ContentControlCollection` object that represents all content controls in the document that are not linked to an XML node. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param stream Optional. The custom XML part. */ - address: string; + selectUnlinkedControls(stream?: Word.CustomXmlPart): Word.ContentControlCollection; /** - * Specifies the text string for the hyperlink's subject line. + * Sends the document as a fax, without any user interaction. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param address The fax address. + * @param subject Optional. The subject of the fax. */ - emailSubject: string; + sendFax(address: string, subject?: string): void; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Opens a message window for sending the document through Microsoft Exchange. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly isExtraInfoRequired: boolean; + sendMail(): void; /** - * Returns the name of the `Hyperlink` object. + * Specifies the table style to use for newly created tables in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param style The style to apply. + * @param setInTemplate Whether to set the style in the template. */ - readonly name: string; + setDefaultTableStyle(style: string, setInTemplate: boolean): void; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Sets the options Microsoft Word uses for encrypting documents with passwords. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param passwordEncryptionProvider The encryption provider. + * @param passwordEncryptionAlgorithm The encryption algorithm. + * @param passwordEncryptionKeyLength The key length. + * @param passwordEncryptFileProperties Optional. Whether to encrypt file properties. */ - screenTip: string; + setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean): void; /** - * Specifies a named location in the destination of the hyperlink. + * Switches form design mode on or off. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - subAddress: string; + toggleFormsDesign(): void; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Applies the specified Extensible Stylesheet Language Transformation (XSLT) file to this document and replaces the document with the results. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param path The path to the XSLT file. + * @param dataOnly Optional. Whether to use data only. */ - target: string; + transformDocument(path: string, dataOnly?: boolean): void; /** - * Specifies the hyperlink's visible text in the document. + * Undoes the last action or a sequence of actions, which are displayed in the Undo list. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param times Optional. The number of actions to undo. + * @returns `true` if the actions were undone successfully; otherwise, `false`. */ - textToDisplay: string; + undo(times?: number): OfficeExtension.ClientResult; /** - * Returns the hyperlink type. + * Clears the list of actions that can be undone in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; + undoClear(): void; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Removes protection from the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param password Optional. The password to unprotect the document. */ - set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Hyperlink): void; + unprotect(password?: string): void; /** - * Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder. + * Copies all styles from the attached template into the document, overwriting any existing styles in the document that have the same name. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - addToFavorites(): void; + updateStyles(): void; /** - * Creates a new document linked to the hyperlink. + * Displays the code window for the selected Microsoft ActiveX control in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + */ + viewCode(): void; + /** + * Displays the property window for the selected Microsoft ActiveX control in the document. * - * @param fileName The name of the file. - * @param editNow `true` to start editing now. - * @param overwrite `true` to overwrite if there's another file with the same name. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void; + viewPropertyBrowser(): void; /** - * Deletes the hyperlink. + * Displays a preview of the current document as it would look if saved as a webpage. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - delete(): void; + webPagePreview(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink; + load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Hyperlink; + load(propertyNames?: string | string[]): Word.Document; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -101172,378 +101986,292 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Hyperlink; + }): Word.Document; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Occurs when the user clicks an annotation (or selects it using **Alt+Down**). + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - track(): Word.Hyperlink; + readonly onAnnotationClicked: OfficeExtension.EventHandlers; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Occurs when the user hovers the cursor over an annotation. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - untrack(): Word.Hyperlink; + readonly onAnnotationHovered: OfficeExtension.EventHandlers; /** - * 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.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.HyperlinkData; - } - /** - * Contains a collection of {@link Word.Hyperlink} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class HyperlinkCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.Hyperlink[]; + * Occurs when the user adds one or more annotations. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty + */ + readonly onAnnotationInserted: OfficeExtension.EventHandlers; /** - * Returns a `Hyperlink` object that represents a new hyperlink added to a range, selection, or document. + * Occurs when the user performs an action in an annotation pop-up menu. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.8] * - * @param anchor The range to which the hyperlink is added. - * @param options Optional. The options to further configure the new hyperlink. + * @eventproperty */ - add(anchor: Word.Range, options?: Word.HyperlinkAddOptions): Word.Hyperlink; + readonly onAnnotationPopupAction: OfficeExtension.EventHandlers; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Occurs when the user deletes one or more annotations. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - load(options?: Word.Interfaces.HyperlinkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HyperlinkCollection; + readonly onAnnotationRemoved: OfficeExtension.EventHandlers; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.5] + * + * @eventproperty */ - load(propertyNames?: string | string[]): Word.HyperlinkCollection; + readonly onContentControlAdded: OfficeExtension.EventHandlers; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Occurs when the user adds new paragraphs. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HyperlinkCollection; + readonly onParagraphAdded: OfficeExtension.EventHandlers; + /** + * Occurs when the user changes paragraphs. + * + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty + */ + readonly onParagraphChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the user deletes paragraphs. + * + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty + */ + readonly onParagraphDeleted: OfficeExtension.EventHandlers; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.HyperlinkCollection; + track(): Word.Document; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.HyperlinkCollection; + untrack(): Word.Document; /** * 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.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.Document` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.HyperlinkCollectionData; + toJSON(): Word.Interfaces.DocumentData; } /** - * Specifies the options for adding to a {@link Word.HyperlinkCollection} object. + * The `DocumentCreated` object is the top level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - interface HyperlinkAddOptions { + class DocumentCreated extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * If provided, specifies the address (e.g., URL or file path) of the hyperlink. + * Gets the `Body` object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiHiddenDocument 1.3] */ - address?: string; + readonly body: Word.Body; /** - * If provided, specifies the text that appears as a tooltip. + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiHiddenDocument 1.3] */ - screenTip?: string; + readonly contentControls: Word.ContentControlCollection; /** - * If provided, specifies the location within the file or document. + * Gets the custom XML parts in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiHiddenDocument 1.4] */ - subAddress?: string; + readonly customXmlParts: Word.CustomXmlPartCollection; /** - * If provided, specifies the name of the frame or window in which to load the hyperlink. + * Gets the properties of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiHiddenDocument 1.3] */ - target?: string; + readonly properties: Word.DocumentProperties; /** - * If provided, specifies the visible text of the hyperlink. + * Gets the collection of `Section` objects in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiHiddenDocument 1.3] */ - textToDisplay?: string; - } - /** - * Represents an inline picture. - * - * @remarks - * [Api set: WordApi 1.1] - */ - class InlinePicture extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + readonly sections: Word.SectionCollection; /** - * Gets the parent paragraph that contains the inline image. + * Gets the add-in's settings in the document. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApiHiddenDocument 1.4] */ - readonly paragraph: Word.Paragraph; + readonly settings: Word.SettingCollection; /** - * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiHiddenDocument 1.3] */ - readonly parentContentControl: Word.ContentControl; + readonly saved: boolean; /** - * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - readonly parentContentControlOrNullObject: Word.ContentControl; + set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DocumentCreated): void; /** - * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * Adds a style into the document by name and type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiHiddenDocument 1.5] + * + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ - readonly parentTable: Word.Table; + addStyle(name: string, type: Word.StyleType): Word.Style; /** - * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Adds a style into the document by name and type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiHiddenDocument 1.5] + * + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ - readonly parentTableCell: Word.TableCell; + addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; /** - * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Deletes a bookmark, if it exists, from the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiHiddenDocument 1.4] + * + * @param name The case-insensitive bookmark name. */ - readonly parentTableCellOrNullObject: Word.TableCell; + deleteBookmark(name: string): void; /** - * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiHiddenDocument 1.4] + * + * @param name The case-insensitive bookmark name. */ - readonly parentTableOrNullObject: Word.Table; + getBookmarkRange(name: string): Word.Range; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Gets a bookmark's range. If the bookmark doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.1] - */ - altTextDescription: string; - /** - * Specifies a string that contains the title for the inline image. - * - * @remarks - * [Api set: WordApi 1.1] - */ - altTextTitle: string; - /** - * Specifies a number that describes the height of the inline image. - * - * @remarks - * [Api set: WordApi 1.1] - */ - height: number; - /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. - * - * @remarks - * [Api set: WordApi 1.1] - */ - hyperlink: string; - /** - * Gets the format of the inline image. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; - /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. - * - * @remarks - * [Api set: WordApi 1.1] - */ - lockAspectRatio: boolean; - /** - * Specifies a number that describes the width of the inline image. - * - * @remarks - * [Api set: WordApi 1.1] - */ - width: number; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.InlinePicture): void; - /** - * Deletes the inline picture from the document. - * - * @remarks - * [Api set: WordApi 1.2] - */ - delete(): void; - /** - * Gets the Base64-encoded string representation of the inline image. - * - * @remarks - * [Api set: WordApi 1.1] - */ - getBase64ImageSrc(): OfficeExtension.ClientResult; - /** - * Gets the next inline image. Throws an `ItemNotFound` error if this inline image is the last one. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getNext(): Word.InlinePicture; - /** - * Gets the next inline image. If this inline image is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * [Api set: WordApiHiddenDocument 1.4] * - * @remarks - * [Api set: WordApi 1.3] + * @param name The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ - getNextOrNullObject(): Word.InlinePicture; + getBookmarkRangeOrNullObject(name: string): Word.Range; /** - * Gets the picture, or the starting or ending point of the picture, as a range. + * Gets the currently supported content controls in the document. * * @remarks - * [Api set: WordApi 1.3] - * - * @param rangeLocation Optional. The range location must be `whole`, `start`, or `end`. - */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; - /** - * Inserts a break at the specified location in the main document. + * [Api set: WordApiHiddenDocument 1.5] * - * @remarks - * [Api set: WordApi 1.2] + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. * - * @param breakType The break type to add. - * @param insertLocation The value must be `before` or `after`. + * @param options Optional. Options that define which content controls are returned. */ - insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Wraps the inline picture with a rich text content control. + * Gets a `StyleCollection` object that represents the whole style set of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiHiddenDocument 1.5] */ - insertContentControl(): Word.ContentControl; + getStyles(): Word.StyleCollection; /** - * Inserts a document at the specified location. + * Inserts a document into the target document at a specific location with additional properties. + Headers, footers, watermarks, and other section properties are copied by default. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApiHiddenDocument 1.5] * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * * @param base64File The Base64-encoded content of a .docx file. - * @param insertLocation The value must be `before` or `after`. - */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; - /** - * Inserts HTML at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] - * - * @param html The HTML to be inserted. - * @param insertLocation The value must be `before` or `after`. - */ - insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; - /** - * Inserts an inline picture at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] - * - * @param base64EncodedImage The Base64-encoded image to be inserted. - * @param insertLocation The value must be `replace`, `before`, or `after`. + * @param insertLocation The value must be `replace`, `start`, or `end`. + * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. */ - insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; /** - * Inserts OOXML at the specified location. + * Opens the document. * * @remarks - * [Api set: WordApi 1.2] - * - * @param ooxml The OOXML to be inserted. - * @param insertLocation The value must be `before` or `after`. + * [Api set: WordApi 1.3] */ - insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + open(): void; /** - * Inserts a paragraph at the specified location. + * Saves the document. * * @remarks - * [Api set: WordApi 1.2] - * - * @param paragraphText The paragraph text to be inserted. - * @param insertLocation The value must be `before` or `after`. - */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; - /** - * Inserts text at the specified location. + * [Api set: WordApiHiddenDocument 1.3] * - * @remarks - * [Api set: WordApi 1.2] + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. * - * @param text Text to be inserted. - * @param insertLocation The value must be `before` or `after`. + * @param saveBehavior Optional. `DocumentCreated` only supports `save`. + * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ - insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; /** - * Selects the inline picture. This causes Word to scroll to the selection. + * Saves the document. * * @remarks - * [Api set: WordApi 1.2] - * - * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. - */ - select(selectionMode?: Word.SelectionMode): void; - /** - * Selects the inline picture. This causes Word to scroll to the selection. + * [Api set: WordApiHiddenDocument 1.3] * - * @remarks - * [Api set: WordApi 1.2] + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. * - * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + * @param saveBehavior Optional. `DocumentCreated` only supports `save`. + * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ - select(selectionMode?: "Select" | "Start" | "End"): void; + save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture; + load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.InlinePicture; + load(propertyNames?: string | string[]): Word.DocumentCreated; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -101552,280 +102280,176 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.InlinePicture; + }): Word.DocumentCreated; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.InlinePicture; + track(): Word.DocumentCreated; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.InlinePicture; + untrack(): Word.DocumentCreated; /** * 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.InlinePicture` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.DocumentCreated` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentCreatedData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.InlinePictureData; + toJSON(): Word.Interfaces.DocumentCreatedData; } /** - * Contains a collection of {@link Word.InlinePicture} objects. + * Represents document properties. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - class InlinePictureCollection extends OfficeExtension.ClientObject { + class DocumentProperties extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.InlinePicture[]; /** - * Gets the first inline image in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the collection of custom properties of the document. * * @remarks * [Api set: WordApi 1.3] */ - getFirst(): Word.InlinePicture; + readonly customProperties: Word.CustomPropertyCollection; /** - * Gets the first inline image in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the application name of the document. * * @remarks * [Api set: WordApi 1.3] */ - getFirstOrNullObject(): Word.InlinePicture; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: Word.Interfaces.InlinePictureCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.InlinePictureCollection; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.InlinePictureCollection; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.InlinePictureCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.InlinePictureCollection; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.InlinePictureCollection; - /** - * 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.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.InlinePictureCollectionData; - } - /** - * Contains a collection of {@link Word.Paragraph} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class List extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + readonly applicationName: string; /** - * Gets paragraphs in the list. + * Specifies the author of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly paragraphs: Word.ParagraphCollection; + author: string; /** - * Gets the list's ID. + * Specifies the category of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly id: number; + category: string; /** - * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly levelExistences: boolean[]; + comments: string; /** - * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. + * Specifies the company of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly levelTypes: Word.ListLevelType[]; - /** - * Gets the font of the bullet, number, or picture at the specified level in the list. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param level The level in the list. - */ - getLevelFont(level: number): Word.Font; + company: string; /** - * Gets the paragraphs that occur at the specified level in the list. + * Gets the creation date of the document. * * @remarks * [Api set: WordApi 1.3] - * - * @param level The level in the list. - */ - getLevelParagraphs(level: number): Word.ParagraphCollection; - /** - * Gets the Base64-encoded string representation of the picture at the specified level in the list. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param level The level in the list. */ - getLevelPicture(level: number): OfficeExtension.ClientResult; + readonly creationDate: Date; /** - * Gets the bullet, number, or picture at the specified level as a string. + * Specifies the format of the document. * * @remarks * [Api set: WordApi 1.3] - * - * @param level The level in the list. */ - getLevelString(level: number): OfficeExtension.ClientResult; + format: string; /** - * Inserts a paragraph at the specified location. + * Specifies the keywords of the document. * * @remarks * [Api set: WordApi 1.3] - * - * @param paragraphText The paragraph text to be inserted. - * @param insertLocation The value must be `start`, `end`, `before`, or `after`. */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; + keywords: string; /** - * Resets the font of the bullet, number, or picture at the specified level in the list. + * Gets the last author of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param level The level in the list. - * @param resetFontName Optional. Indicates whether to reset the font name. Default is `false` that indicates the font name remains unchanged. + * [Api set: WordApi 1.3] */ - resetLevelFont(level: number, resetFontName?: boolean): void; + readonly lastAuthor: string; /** - * Sets the alignment of the bullet, number, or picture at the specified level in the list. + * Gets the last print date of the document. * * @remarks * [Api set: WordApi 1.3] - * - * @param level The level in the list. - * @param alignment The level alignment that must be `left`, `centered`, or `right`. */ - setLevelAlignment(level: number, alignment: Word.Alignment): void; + readonly lastPrintDate: Date; /** - * Sets the alignment of the bullet, number, or picture at the specified level in the list. + * Gets the last save time of the document. * * @remarks * [Api set: WordApi 1.3] - * - * @param level The level in the list. - * @param alignment The level alignment that must be `left`, `centered`, or `right`. */ - setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void; + readonly lastSaveTime: Date; /** - * Sets the bullet format at the specified level in the list. If the bullet is `custom`, the `charCode` is required. + * Specifies the manager of the document. * * @remarks * [Api set: WordApi 1.3] - * - * @param level The level in the list. - * @param listBullet The bullet. - * @param charCode Optional. The bullet character's code value. Used only if the bullet is `custom`. - * @param fontName Optional. The bullet's font name. Used only if the bullet is `custom`. */ - setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void; + manager: string; /** - * Sets the bullet format at the specified level in the list. If the bullet is `custom`, the `charCode` is required. + * Gets the revision number of the document. * * @remarks * [Api set: WordApi 1.3] - * - * @param level The level in the list. - * @param listBullet The bullet. - * @param charCode Optional. The bullet character's code value. Used only if the bullet is `custom`. - * @param fontName Optional. The bullet's font name. Used only if the bullet is `custom`. */ - setLevelBullet(level: number, listBullet: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void; + readonly revisionNumber: string; /** - * Sets the two indents of the specified level in the list. + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. * * @remarks * [Api set: WordApi 1.3] - * - * @param level The level in the list. - * @param textIndent The text indent in points. It is the same as paragraph left indent. - * @param bulletNumberPictureIndent The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. */ - setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; + readonly security: number; /** - * Sets the numbering format at the specified level in the list. + * Specifies the subject of the document. * * @remarks * [Api set: WordApi 1.3] - * - * @param level The level in the list. - * @param listNumbering The ordinal format. - * @param formatString Optional. The numbering string format defined as an array of strings or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ - setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array): void; + subject: string; /** - * Sets the numbering format at the specified level in the list. + * Gets the template of the document. * * @remarks * [Api set: WordApi 1.3] - * - * @param level The level in the list. - * @param listNumbering The ordinal format. - * @param formatString Optional. The numbering string format defined as an array of strings or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ - setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array): void; + readonly template: string; /** - * Sets the picture at the specified level in the list. + * Specifies the title of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param level The level in the list. - * @param base64EncodedImage Optional. The Base64-encoded image to be set. If not given, the default picture is set. + * [Api set: WordApi 1.3] */ - setLevelPicture(level: number, base64EncodedImage?: string): void; + title: string; /** - * Sets the starting number at the specified level in the list. Default value is 1. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param level The level in the list. - * @param startingNumber The number to start with. + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - setLevelStartingNumber(level: number, startingNumber: number): void; + set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DocumentProperties): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.ListLoadOptions): Word.List; + load(options?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.List; + load(propertyNames?: string | string[]): Word.DocumentProperties; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -101834,182 +102458,124 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.List; + }): Word.DocumentProperties; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.List; + track(): Word.DocumentProperties; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.List; + untrack(): Word.DocumentProperties; /** * 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.List` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ListData; + toJSON(): Word.Interfaces.DocumentPropertiesData; } /** - * Contains a collection of {@link Word.List} objects. + * The data specific to content controls of type `dropDownList`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.9] */ - class ListCollection extends OfficeExtension.ClientObject { + class DropDownListContentControl extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.List[]; - /** - * Gets a list by its identifier. Throws an `ItemNotFound` error if there isn't a list with the identifier in this collection. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param id A list identifier. - */ - getById(id: number): Word.List; /** - * Gets a list by its identifier. If there isn't a list with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the collection of list items in the dropdown list content control. * * @remarks - * [Api set: WordApi 1.3] - * - * @param id A list identifier. + * [Api set: WordApi 1.9] */ - getByIdOrNullObject(id: number): Word.List; + readonly listItems: Word.ContentControlListItemCollection; /** - * Gets the first list in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object. * * @remarks - * [Api set: WordApi 1.3] - */ - getFirst(): Word.List; - /** - * Gets the first list in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * [Api set: WordApi 1.9] * - * @remarks - * [Api set: WordApi 1.3] + * @param displayText Display text of the list item. + * @param value Optional. Value of the list item. + * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. */ - getFirstOrNullObject(): Word.List; + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; /** - * Gets a `List` object by its ID. + * Deletes all list items in this dropdown list content control. * * @remarks - * [Api set: WordApi 1.3] - * - * @param id The list's ID. - */ - getItem(id: number): Word.List; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * [Api set: WordApi 1.9] */ - load(options?: Word.Interfaces.ListCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListCollection; + deleteAllListItems(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.ListCollection; + load(propertyNames?: string | string[]): Word.DropDownListContentControl; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DropDownListContentControl; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListCollection; + track(): Word.DropDownListContentControl; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListCollection; + untrack(): Word.DropDownListContentControl; /** * 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.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.DropDownListContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropDownListContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ListCollectionData; + toJSON(): Word.Interfaces.DropDownListContentControlData; } /** - * Represents the paragraph list item format. + * The data specific to content controls of type `comboBox`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.9] */ - class ListItem extends OfficeExtension.ClientObject { + class ComboBoxContentControl extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies the level of the item in the list. + * Gets the collection of list items in the combo box content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.9] */ - level: number; + readonly listItems: Word.ContentControlListItemCollection; /** - * Gets the list item bullet, number, or picture as a string. + * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.9] + * + * @param displayText Display text of the list item. + * @param value Optional. Value of the list item. + * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. */ - readonly listString: string; + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; /** - * Gets the list item order number in relation to its siblings. + * Deletes all list items in this combo box content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.9] */ - readonly siblingIndex: number; + deleteAllListItems(): void; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - set(properties: Interfaces.ListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListItem): void; - /** - * Gets the list item parent, or the closest ancestor if the parent doesn't exist. Throws an `ItemNotFound` error if the list item has no ancestor. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is `false` that specifies to get the lowest ancestor. - */ - getAncestor(parentOnly?: boolean): Word.Paragraph; - /** - * Gets the list item parent, or the closest ancestor if the parent doesn't exist. If the list item has no ancestor, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is `false` that specifies to get the lowest ancestor. - */ - getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph; - /** - * Gets all descendant list items of the list item. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param directChildrenOnly Optional. Specifies only the list item's direct children will be returned. The default is `false` that indicates to get all descendant items. - */ - getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: Word.Interfaces.ListItemLoadOptions): Word.ListItem; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.ListItem; + load(propertyNames?: string | string[]): Word.ComboBoxContentControl; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -102018,344 +102584,249 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.ListItem; + }): Word.ComboBoxContentControl; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListItem; + track(): Word.ComboBoxContentControl; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListItem; + untrack(): Word.ComboBoxContentControl; /** * 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.ListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListItemData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ComboBoxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ComboBoxContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ListItemData; + toJSON(): Word.Interfaces.ComboBoxContentControlData; } /** - * Represents a list level. + * Represents a field. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. */ - class ListLevel extends OfficeExtension.ClientObject { + class Field extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * Gets a `LinkFormat` object that represents the link options of the field. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - readonly font: Word.Font; + readonly linkFormat: Word.LinkFormat; /** - * Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. + * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + readonly oleFormat: Word.OleFormat; /** - * Specifies the name of the style that's linked to the `ListLevel` object. + * Gets the parent body of the field. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - linkedStyle: string; + readonly parentBody: Word.Body; /** - * Specifies the number format for the list level. + * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - numberFormat: string; + readonly parentContentControl: Word.ContentControl; /** - * Specifies the position (in points) of the number or bullet for the `ListLevel` object. + * Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - numberPosition: number; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Specifies the number style for the `ListLevel` object. + * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + readonly parentTable: Word.Table; /** - * Specifies the list level that must appear before it restarts numbering at 1. + * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - resetOnHigher: number; + readonly parentTableCell: Word.TableCell; /** - * Specifies the starting number for the `ListLevel` object. + * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - startAt: number; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * Specifies the tab position for the `ListLevel` object. + * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - tabPosition: number; + readonly parentTableOrNullObject: Word.Table; /** - * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. + * Gets the field's result data. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - textPosition: number; + readonly result: Word.Range; /** - * Specifies the character inserted after the number for the list level. + * Specifies the field's code instruction. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - trailingCharacter: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.ListLevelUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListLevel): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: Word.Interfaces.ListLevelLoadOptions): Word.ListLevel; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.ListLevel; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * [Api set: WordApi 1.4] * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ListLevel; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListLevel; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Note: The ability to set the code was introduced in WordApi 1.5. */ - untrack(): Word.ListLevel; - /** - * 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.ListLevel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.ListLevelData; - } - /** - * Contains a collection of {@link Word.ListLevel} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - class ListLevelCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.ListLevel[]; + code: string; /** - * Gets the first list level in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - getFirst(): Word.ListLevel; + data: string; /** - * Gets the first list level in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the field's kind. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - getFirstOrNullObject(): Word.ListLevel; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: Word.Interfaces.ListLevelCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListLevelCollection; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * [Api set: WordApi 1.5] */ - load(propertyNames?: string | string[]): Word.ListLevelCollection; + readonly kind: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListLevelCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListLevelCollection; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * @remarks + * [Api set: WordApi 1.5] */ - untrack(): Word.ListLevelCollection; - /** - * 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.ListLevelCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.ListLevelCollectionData; - } - /** - * Represents a list template. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - class ListTemplate extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + locked: boolean; /** - * Gets a `ListLevelCollection` object that represents all the levels for the list template. + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks * [Api set: WordApiDesktop 1.1] */ - readonly listLevels: Word.ListLevelCollection; + showCodes: boolean; /** - * Specifies whether the list template is outline numbered. + * Gets the field's type. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - outlineNumbered: boolean; + readonly type: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.ListTemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.FieldUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListTemplate): void; + set(properties: Word.Field): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Copies the field to the Clipboard. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.ListTemplateLoadOptions): Word.ListTemplate; + copyToClipboard(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Removes the field from the document and places it on the Clipboard. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.ListTemplate; + cut(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Deletes the field. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApi 1.5] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ListTemplate; + delete(): void; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Clicks the field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.ListTemplate; + doClick(): void; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets the next field. Throws an `ItemNotFound` error if this field is the last one. + * + * @remarks + * [Api set: WordApi 1.4] */ - untrack(): Word.ListTemplate; - /** - * 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.ListTemplate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.ListTemplateData; - } - /** - * Represents a footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ - class NoteItem extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + getNext(): Word.Field; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Gets the next field. If this field is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.4] */ - readonly body: Word.Body; + getNextOrNullObject(): Word.Field; /** - * Represents a footnote or endnote reference in the main document. + * Selects the field. * * @remarks * [Api set: WordApi 1.5] + * + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ - readonly reference: Word.Range; + select(selectionMode?: Word.SelectionMode): void; /** - * Represents the note item type: footnote or endnote. + * Selects the field. * * @remarks * [Api set: WordApi 1.5] + * + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ - readonly type: Word.NoteItemType | "Footnote" | "Endnote"; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.NoteItem): void; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Deletes the note item. + * Replaces the field with its most recent result. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - delete(): void; + unlink(): void; /** - * Gets the next note item of the same type. Throws an `ItemNotFound` error if this note item is the last one. + * Updates the field. * * @remarks * [Api set: WordApi 1.5] */ - getNext(): Word.NoteItem; + updateResult(): void; /** - * Gets the next note item of the same type. If this note item is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Saves the changes made to the results of an {@link https://support.microsoft.com/office/1c34d6d6-0de3-4b5c-916a-2ff950fb629e | INCLUDETEXT field} back to the source document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - getNextOrNullObject(): Word.NoteItem; + updateSource(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem; + load(options?: Word.Interfaces.FieldLoadOptions): Word.Field; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.NoteItem; + load(propertyNames?: string | string[]): Word.Field; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -102364,376 +102835,605 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.NoteItem; + }): Word.Field; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.NoteItem; + track(): Word.Field; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.NoteItem; + untrack(): Word.Field; /** * 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.NoteItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Field` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.NoteItemData; + toJSON(): Word.Interfaces.FieldData; } /** - * Contains a collection of {@link Word.NoteItem} objects. + * Contains a collection of {@link Word.Field} objects. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. */ - class NoteItemCollection extends OfficeExtension.ClientObject { + class FieldCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.NoteItem[]; + readonly items: Word.Field[]; /** - * Gets the first note item in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the first field in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.4] */ - getFirst(): Word.NoteItem; + getFirst(): Word.Field; /** - * Gets the first note item in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the first field in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getFirstOrNullObject(): Word.Field; + /** + * Gets the `FieldCollection` object including the specified types of fields. * * @remarks * [Api set: WordApi 1.5] + * + * @param types An array of field types. */ - getFirstOrNullObject(): Word.NoteItem; + getByTypes(types: Word.FieldType[]): Word.FieldCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection; + load(options?: Word.Interfaces.FieldCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FieldCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.NoteItemCollection; + load(propertyNames?: string | string[]): Word.FieldCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.NoteItemCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.NoteItemCollection; + track(): Word.FieldCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.NoteItemCollection; + untrack(): Word.FieldCollection; /** * 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.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.NoteItemCollectionData; + toJSON(): Word.Interfaces.FieldCollectionData; } /** - * Represents a page in the document. `Page` objects manage the page layout and content. + * Represents a font. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - class Page extends OfficeExtension.ClientObject { + class Font extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets a `BreakCollection` object that represents the breaks on the page. + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly breaks: Word.BreakCollection; + readonly borders: Word.BorderUniversalCollection; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - readonly height: number; + readonly fill: Word.FillFormat; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - readonly index: number; + readonly glow: Word.GlowFormat; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - readonly width: number; + readonly line: Word.LineFormat; /** - * Gets the next page in the pane. Throws an `ItemNotFound` error if this page is the last one. + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - getNext(): Word.Page; + readonly reflection: Word.ReflectionFormat; /** - * Gets the next page. If this page is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - getNextOrNullObject(): Word.Page; + readonly textColor: Word.ColorFormat; /** - * Gets the whole page, or the starting or ending point of the page, as a range. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param rangeLocation Optional. The range location must be `whole`, `start`, or `end`. + * [Api set: WordApiDesktop 1.3] */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + readonly textShadow: Word.ShadowFormat; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(options?: Word.Interfaces.PageLoadOptions): Word.Page; + readonly threeDimensionalFormat: Word.ThreeDimensionalFormat; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNames?: string | string[]): Word.Page; + allCaps: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApi 1.1] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Page; + bold: boolean; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. + * + * @remarks + * [Api set: WordApiDesktop 1.3] */ - track(): Word.Page; + boldBidirectional: boolean; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] */ - untrack(): Word.Page; - /** - * 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.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.PageData; - } - /** - * Represents the collection of {@link Word.Page} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - class PageCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.Page[]; + color: string; /** - * Gets the first page in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - getFirst(): Word.Page; + colorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Gets the first page in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - getFirstOrNullObject(): Word.Page; + colorIndexBidirectional: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether contextual alternates are enabled for the font. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(options?: Word.Interfaces.PageCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PageCollection; + contextualAlternates: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNames?: string | string[]): Word.PageCollection; + diacriticColor: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.PageCollection; + disableCharacterSpaceGrid: boolean; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] */ - track(): Word.PageCollection; + doubleStrikeThrough: boolean; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] */ - untrack(): Word.PageCollection; + emboss: boolean; /** - * 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.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.PageCollectionData; - } - /** - * Represents a window pane. The `Pane` object is a member of the pane collection. The pane collection includes all the window panes for a single window. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - class Pane extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Gets the collection of pages in the pane. + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - readonly pages: Word.PageCollection; + engrave: boolean; /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ - readonly pagesEnclosingViewport: Word.PageCollection; + hidden: boolean; /** - * Gets the next pane in the window. Throws an `ItemNotFound` error if this pane is the last one. + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to `null`. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - getNext(): Word.Pane; + highlightColor: string; /** - * Gets the next pane. If this pane is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - getNextOrNullObject(): Word.Pane; + italic: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNames?: string | string[]): Word.Pane; + italicBidirectional: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Pane; + kerning: number; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the ligature setting for the `Font` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] */ - track(): Word.Pane; + ligature: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] */ - untrack(): Word.Pane; + name: string; /** - * 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.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.PaneData; - } - /** - * Represents the collection of {@link Word.Pane} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - class PaneCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.Pane[]; + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nameAscii: string; /** - * Gets the first pane in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies the font name in a right-to-left language document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - getFirst(): Word.Pane; + nameBidirectional: string; /** - * Gets the first pane in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Specifies the East Asian font name. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - getFirstOrNullObject(): Word.Pane; + nameFarEast: string; + /** + * Specifies the font used for characters with codes from 128 through 255. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nameOther: string; + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + numberForm: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + /** + * Specifies the number spacing setting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + numberSpacing: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + /** + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + outline: boolean; + /** + * Specifies the position of text (in points) relative to the base line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + position: number; + /** + * Specifies the scaling percentage applied to the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + scaling: number; + /** + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shadow: boolean; + /** + * Specifies the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size: number; + /** + * Specifies the font size in points for right-to-left text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sizeBidirectional: number; + /** + * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + smallCaps: boolean; + /** + * Specifies the spacing between characters. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spacing: number; + /** + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough: boolean; + /** + * Specifies the stylistic set for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + stylisticSet: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + /** + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript: boolean; + /** + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript: boolean; + /** + * Specifies the font's underline type. `none` if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + underlineColor: string; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.FontUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Font): void; + /** + * Decreases the font size to the next available size. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + decreaseFontSize(): void; + /** + * Increases the font size to the next available size. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + increaseFontSize(): void; + /** + * Removes manual character formatting. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + reset(): void; + /** + * Sets the specified font formatting as the default for the active document and all new documents based on the active template. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setAsTemplateDefault(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.FontLoadOptions): Word.Font; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.PaneCollection; + load(propertyNames?: string | string[]): Word.Font; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.PaneCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Font; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.PaneCollection; + track(): Word.Font; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.PaneCollection; + untrack(): Word.Font; /** * 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.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.PaneCollectionData; + toJSON(): Word.Interfaces.FontData; } /** - * Represents the window that displays the document. A window can be split to contain multiple reading panes. + * Represents a heading style used in a table of contents or table of figures. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - class Window extends OfficeExtension.ClientObject { + class HeadingStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the active pane in the window. + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - readonly activePane: Word.Pane; + level: number; /** - * Gets the collection of panes in the window. + * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - readonly panes: Word.PaneCollection; + name: string; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.HeadingStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.HeadingStyle): void; + /** + * Deletes the heading style. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + delete(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.HeadingStyleLoadOptions): Word.HeadingStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Window; + load(propertyNames?: string | string[]): Word.HeadingStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -102742,732 +103442,579 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Window; + }): Word.HeadingStyle; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Window; + track(): Word.HeadingStyle; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Window; + untrack(): Word.HeadingStyle; /** * 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.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.HeadingStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.WindowData; + toJSON(): Word.Interfaces.HeadingStyleData; } /** - * Represents the collection of {@link Word.Window} objects. + * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - class WindowCollection extends OfficeExtension.ClientObject { + class HeadingStyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.Window[]; + readonly items: Word.HeadingStyle[]; /** - * Gets the first window in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Adds a new heading style to a document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] + * + * @param name The style name to be added. + * @param level The heading level to assign. Must be a value from 1 to 9. + * @returns The new `HeadingStyle` object that was added to the collection. */ - getFirst(): Word.Window; + add(name: string, level: number): Word.HeadingStyle; /** - * Gets the first window in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param options Provides options for which properties of the object to load. */ - getFirstOrNullObject(): Word.Window; + load(options?: Word.Interfaces.HeadingStyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HeadingStyleCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.WindowCollection; + load(propertyNames?: string | string[]): Word.HeadingStyleCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.WindowCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HeadingStyleCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.WindowCollection; + track(): Word.HeadingStyleCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.WindowCollection; + untrack(): Word.HeadingStyleCollection; /** * 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.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.HeadingStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.WindowCollectionData; + toJSON(): Word.Interfaces.HeadingStyleCollectionData; } /** - * Represents a single paragraph in a selection, range, content control, or document body. + * Represents a hyperlink in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - class Paragraph extends OfficeExtension.ClientObject { + class Hyperlink extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly borders: Word.BorderUniversalCollection; + readonly range: Word.Range; /** - * Gets the collection of `ContentControl` objects in the paragraph. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - readonly contentControls: Word.ContentControlCollection; + address: string; /** - * Gets the collection of endnotes in the paragraph. + * Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - readonly endnotes: Word.NoteItemCollection; + emailSubject: string; /** - * Gets the collection of fields in the paragraph. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - readonly fields: Word.FieldCollection; + readonly isExtraInfoRequired: boolean; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Returns the name of the `Hyperlink` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - readonly font: Word.Font; + readonly name: string; /** - * Gets the collection of footnotes in the paragraph. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - readonly footnotes: Word.NoteItemCollection; + screenTip: string; /** - * Gets the collection of `InlinePicture` objects in the paragraph. The collection doesn't include floating images. + * Specifies a named location in the destination of the hyperlink. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - readonly inlinePictures: Word.InlinePictureCollection; + subAddress: string; /** - * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly list: Word.List; + target: string; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * Specifies the hyperlink's visible text in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly listItem: Word.ListItem; + textToDisplay: string; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Returns the hyperlink type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly listItemOrNullObject: Word.ListItem; + readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; /** - * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - readonly listOrNullObject: Word.List; + set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Hyperlink): void; /** - * Gets the parent body of the paragraph. + * Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly parentBody: Word.Body; + addToFavorites(): void; /** - * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * Creates a new document linked to the hyperlink. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] + * + * @param fileName The name of the file. + * @param editNow `true` to start editing now. + * @param overwrite `true` to overwrite if there's another file with the same name. */ - readonly parentContentControl: Word.ContentControl; + createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void; /** - * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Deletes the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly parentContentControlOrNullObject: Word.ContentControl; + delete(): void; /** - * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options Provides options for which properties of the object to load. */ - readonly parentTable: Word.Table; + load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink; /** - * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly parentTableCell: Word.TableCell; + load(propertyNames?: string | string[]): Word.Hyperlink; /** - * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - readonly parentTableCellOrNullObject: Word.TableCell; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Hyperlink; /** - * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - readonly parentTableOrNullObject: Word.Table; + track(): Word.Hyperlink; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - readonly shading: Word.ShadingUniversal; + untrack(): Word.Hyperlink; /** - * Gets the collection of `Shape` objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * 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.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.HyperlinkData; + } + /** + * Contains a collection of {@link Word.Hyperlink} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class HyperlinkCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Hyperlink[]; + /** + * Returns a `Hyperlink` object that represents a new hyperlink added to a range, selection, or document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] * - * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + * @param anchor The range to which the hyperlink is added. + * @param options Optional. The options to further configure the new hyperlink. */ - readonly shapes: Word.ShapeCollection; + add(anchor: Word.Range, options?: Word.HyperlinkAddOptions): Word.Hyperlink; /** - * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param options Provides options for which properties of the object to load. */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + load(options?: Word.Interfaces.HyperlinkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HyperlinkCollection; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - firstLineIndent: number; + load(propertyNames?: string | string[]): Word.HyperlinkCollection; /** - * Indicates the paragraph is the last one inside its parent body. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - readonly isLastParagraph: boolean; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HyperlinkCollection; /** - * Checks whether the paragraph is a list item. - * - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - readonly isListItem: boolean; + track(): Word.HyperlinkCollection; /** - * Specifies the left indent value, in points, for the paragraph. - * - * @remarks - * [Api set: WordApi 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - leftIndent: number; + untrack(): Word.HyperlinkCollection; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. - * - * @remarks - * [Api set: WordApi 1.1] - */ - lineSpacing: number; + * 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.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.HyperlinkCollectionData; + } + /** + * Specifies the options for adding to a {@link Word.HyperlinkCollection} object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface HyperlinkAddOptions { /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * If provided, specifies the address (e.g., URL or file path) of the hyperlink. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - lineUnitAfter: number; + address?: string; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * If provided, specifies the text that appears as a tooltip. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - lineUnitBefore: number; + screenTip?: string; /** - * Specifies the outline level for the paragraph. + * If provided, specifies the location within the file or document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - outlineLevel: number; + subAddress?: string; /** - * Specifies the right indent value, in points, for the paragraph. + * If provided, specifies the name of the frame or window in which to load the hyperlink. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - rightIndent: number; + target?: string; /** - * Specifies the spacing, in points, after the paragraph. + * If provided, specifies the visible text of the hyperlink. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - spaceAfter: number; + textToDisplay?: string; + } + /** + * Represents an inline picture. + * + * @remarks + * [Api set: WordApi 1.1] + */ + class InlinePicture extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Specifies the spacing, in points, before the paragraph. + * Gets the parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.2] */ - spaceBefore: number; + readonly paragraph: Word.Paragraph; /** - * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks * [Api set: WordApi 1.1] */ - style: string; + readonly parentContentControl: Word.ContentControl; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks * [Api set: WordApi 1.3] */ - readonly tableNestingLevel: number; + readonly parentTable: Word.Table; /** - * Gets the text of the paragraph. + * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - readonly text: string; + readonly parentTableCell: Word.TableCell; /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.6] - */ - readonly uniqueLocalId: string; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * [Api set: WordApi 1.3] */ - set(properties: Interfaces.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Paragraph): void; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * Lets the paragraph join an existing list at the specified level. Fails if the paragraph cannot join the list or if the paragraph is already a list item. + * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] - * - * @param listId The ID of an existing list. - * @param level The level in the list. */ - attachToList(listId: number, level: number): Word.List; + readonly parentTableOrNullObject: Word.Table; /** - * Clears the contents of the `Paragraph` object. The user can perform the undo operation on the cleared content. + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks * [Api set: WordApi 1.1] */ - clear(): void; + altTextDescription: string; /** - * Deletes the paragraph and its content from the document. + * Specifies a string that contains the title for the inline image. * * @remarks * [Api set: WordApi 1.1] */ - delete(): void; + altTextTitle: string; /** - * Moves this paragraph out of its list, if the paragraph is a list item. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - detachFromList(): void; + height: number; /** - * Gets annotations set on this `Paragraph` object. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.7] - * - * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. + * [Api set: WordApi 1.1] */ - getAnnotations(): Word.AnnotationCollection; + hyperlink: string; /** - * Gets comments associated with the paragraph. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.1] */ - getComments(): Word.CommentCollection; + readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; /** - * Gets the currently supported content controls in the paragraph. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApi 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options Optional. Options that define which content controls are returned. + * [Api set: WordApi 1.1] */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + lockAspectRatio: boolean; /** - * Gets an HTML representation of the `Paragraph` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. + * Specifies a number that describes the width of the inline image. * * @remarks * [Api set: WordApi 1.1] */ - getHtml(): OfficeExtension.ClientResult; + width: number; /** - * Gets the next paragraph. Throws an `ItemNotFound` error if the paragraph is the last one. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - getNext(): Word.Paragraph; + set(properties: Interfaces.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.InlinePicture): void; /** - * Gets the next paragraph. If the paragraph is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Deletes the inline picture from the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.2] */ - getNextOrNullObject(): Word.Paragraph; + delete(): void; /** - * Gets the Office Open XML (OOXML) representation of the `Paragraph` object. + * Gets the Base64-encoded string representation of the inline image. * * @remarks * [Api set: WordApi 1.1] */ - getOoxml(): OfficeExtension.ClientResult; - /** - * Gets the previous paragraph. Throws an `ItemNotFound` error if the paragraph is the first one. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getPrevious(): Word.Paragraph; + getBase64ImageSrc(): OfficeExtension.ClientResult; /** - * Gets the previous paragraph. If the paragraph is the first one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the next inline image. Throws an `ItemNotFound` error if this inline image is the last one. * * @remarks * [Api set: WordApi 1.3] */ - getPreviousOrNullObject(): Word.Paragraph; + getNext(): Word.InlinePicture; /** - * Gets the whole paragraph, or the starting or ending point of the paragraph, as a range. + * Gets the next inline image. If this inline image is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] - * - * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `after`, or `content`. - */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; - /** - * Gets reviewed text based on `ChangeTrackingVersion` selection. - * - * @remarks - * [Api set: WordApi 1.4] - * - * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. - */ - getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; - /** - * Gets reviewed text based on `ChangeTrackingVersion` selection. - * - * @remarks - * [Api set: WordApi 1.4] - * - * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. - */ - getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; - /** - * Returns the text of the paragraph. This excludes equations, graphics (e.g., images, videos, drawings), and special characters that mark various content (e.g., for content controls, fields, comments, footnotes, endnotes). - By default, hidden text and text marked as deleted are excluded. - * - * @remarks - * [Api set: WordApi 1.7] - * - * @param options Optional. Options that define whether the final result should include hidden text and text marked as deleted. */ - getText(options?: Word.GetTextOptions | { - IncludeHiddenText?: boolean; - IncludeTextMarkedAsDeleted?: boolean; - }): OfficeExtension.ClientResult; + getNextOrNullObject(): Word.InlinePicture; /** - * Gets the text ranges in the paragraph by using punctuation marks and other ending marks. + * Gets the picture, or the starting or ending point of the picture, as a range. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks The punctuation marks and other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. - */ - getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; - /** - * Gets the collection of the `TrackedChange` objects in the paragraph. - * - * @remarks - * [Api set: WordApi 1.6] - */ - getTrackedChanges(): Word.TrackedChangeCollection; - /** - * Inserts annotations on this `Paragraph` object. - * - * @remarks - * [Api set: WordApi 1.7] - * - * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. - * - * @param annotations Annotations to set. - * @returns An array of the inserted annotations identifiers. + * @param rangeLocation Optional. The range location must be `whole`, `start`, or `end`. */ - insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** * Inserts a break at the specified location in the main document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.2] * - * @param breakType The break type to add to the document. + * @param breakType The break type to add. * @param insertLocation The value must be `before` or `after`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** - * Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param insertShapeOptions Optional. The location and size of canvas. The default location and size is (0, 0, 300, 200). - */ - insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; - /** - * Wraps the `Paragraph` object with a content control. + * Wraps the inline picture with a rich text content control. * * @remarks * [Api set: WordApi 1.1] - * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. - * `dropDownList` and `comboBox` support was added in WordApi 1.9. Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. - * - * @param contentControlType Optional. Content control type to insert. Must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. The default is `richText`. */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl; + insertContentControl(): Word.ContentControl; /** - * Inserts a document into the paragraph at the specified location. + * Inserts a document at the specified location. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.2] * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * * @param base64File The Base64-encoded content of a .docx file. - * @param insertLocation The value must be `replace`, `start`, or `end`. - */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; - /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param geometricShapeType The geometric type of the shape to insert. - * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). - */ - insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; - /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param geometricShapeType The geometric type of the shape to insert. - * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). + * @param insertLocation The value must be `before` or `after`. */ - insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Inserts HTML into the paragraph at the specified location. + * Inserts HTML at the specified location. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.2] * - * @param html The HTML to be inserted in the paragraph. - * @param insertLocation The value must be `replace`, `start`, or `end`. + * @param html The HTML to be inserted. + * @param insertLocation The value must be `before` or `after`. */ - insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Inserts a picture into the paragraph at the specified location. + * Inserts an inline picture at the specified location. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.2] * * @param base64EncodedImage The Base64-encoded image to be inserted. - * @param insertLocation The value must be `replace`, `start`, or `end`. + * @param insertLocation The value must be `replace`, `before`, or `after`. */ - insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture; /** - * Inserts OOXML into the paragraph at the specified location. + * Inserts OOXML at the specified location. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.2] * - * @param ooxml The OOXML to be inserted in the paragraph. - * @param insertLocation The value must be `replace`, `start`, or `end`. + * @param ooxml The OOXML to be inserted. + * @param insertLocation The value must be `before` or `after`. */ - insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** * Inserts a paragraph at the specified location. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.2] * * @param paragraphText The paragraph text to be inserted. * @param insertLocation The value must be `before` or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** - * Inserts a floating picture in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param base64EncodedImage The Base64-encoded image to be inserted. - * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. - */ - insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; - /** - * Inserts a table with the specified number of rows and columns. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param rowCount The number of rows in the table. - * @param columnCount The number of columns in the table. - * @param insertLocation The value must be `before` or `after`. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. - */ - insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; - /** - * Inserts text into the paragraph at the specified location. + * Inserts text at the specified location. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.2] * * @param text Text to be inserted. - * @param insertLocation The value must be `replace`, `start`, or `end`. - */ - insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; - /** - * Inserts a floating text box in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param text Optional. The text to insert into the text box. - * @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100). - */ - insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; - /** - * Performs a search with the specified search options on the scope of the `Paragraph` object. The search results are a collection of `Range` objects. - * - * @remarks - * [Api set: WordApi 1.1] - * - * @param searchText The search text. - * @param searchOptions Optional. Options for the search. + * @param insertLocation The value must be `before` or `after`. */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Selects and navigates the Word UI to the paragraph. + * Selects the inline picture. This causes Word to scroll to the selection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.2] * * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** - * Selects and navigates the Word UI to the paragraph. + * Selects the inline picture. This causes Word to scroll to the selection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.2] * * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; - /** - * Splits the paragraph into child ranges by using delimiters. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param delimiters The delimiters as an array of strings. - * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is `false` which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. - */ - split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; - /** - * Starts a new list with this paragraph. Fails if the paragraph is already a list item. - * - * @remarks - * [Api set: WordApi 1.3] - */ - startNewList(): Word.List; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.ParagraphLoadOptions): Word.Paragraph; + load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Paragraph; + load(propertyNames?: string | string[]): Word.InlinePicture; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -103476,219 +104023,163 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Paragraph; + }): Word.InlinePicture; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Paragraph; + track(): Word.InlinePicture; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Paragraph; + untrack(): Word.InlinePicture; /** * 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.Paragraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.InlinePicture` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ParagraphData; + toJSON(): Word.Interfaces.InlinePictureData; } /** - * Contains a collection of {@link Word.Paragraph} objects. + * Contains a collection of {@link Word.InlinePicture} objects. * * @remarks * [Api set: WordApi 1.1] */ - class ParagraphCollection extends OfficeExtension.ClientObject { + class InlinePictureCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.Paragraph[]; - /** - * Gets the first paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getFirst(): Word.Paragraph; - /** - * Gets the first paragraph in this collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getFirstOrNullObject(): Word.Paragraph; + readonly items: Word.InlinePicture[]; /** - * Gets the last paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. + * Gets the first inline image in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks * [Api set: WordApi 1.3] */ - getLast(): Word.Paragraph; + getFirst(): Word.InlinePicture; /** - * Gets the last paragraph in this collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the first inline image in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] */ - getLastOrNullObject(): Word.Paragraph; + getFirstOrNullObject(): Word.InlinePicture; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection; + load(options?: Word.Interfaces.InlinePictureCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.InlinePictureCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.ParagraphCollection; + load(propertyNames?: string | string[]): Word.InlinePictureCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.InlinePictureCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ParagraphCollection; + track(): Word.InlinePictureCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ParagraphCollection; + untrack(): Word.InlinePictureCollection; /** * 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.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.ParagraphCollectionData; + toJSON(): Word.Interfaces.InlinePictureCollectionData; } /** - * Represents a style of paragraph in a document. + * Represents the linking characteristics for an OLE object or picture. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - class ParagraphFormat extends OfficeExtension.ClientObject { + class LinkFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies the alignment for the specified paragraphs. - * - * @remarks - * [Api set: WordApi 1.5] - */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; - /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. - * - * @remarks - * [Api set: WordApi 1.5] - */ - firstLineIndent: number; - /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. - * - * @remarks - * [Api set: WordApi 1.5] - */ - keepTogether: boolean; - /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. - * - * @remarks - * [Api set: WordApi 1.5] - */ - keepWithNext: boolean; - /** - * Specifies the left indent. - * - * @remarks - * [Api set: WordApi 1.5] - */ - leftIndent: number; - /** - * Specifies the line spacing (in points) for the specified paragraphs. - * - * @remarks - * [Api set: WordApi 1.5] - */ - lineSpacing: number; - /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. - * - * @remarks - * [Api set: WordApi 1.5] - */ - lineUnitAfter: number; - /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - lineUnitBefore: number; + isAutoUpdated: boolean; /** - * Specifies whether left and right indents are the same width. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - mirrorIndents: boolean; + isLocked: boolean; /** - * Specifies the outline level for the specified paragraphs. + * Specifies if the linked picture is saved with the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + isPictureSavedWithDocument: boolean; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - rightIndent: number; + sourceFullName: string; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - spaceAfter: number; + readonly sourceName: string; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - spaceBefore: number; + readonly sourcePath: string; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Gets the link type. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - widowControl: boolean; + readonly type: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.LinkFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ParagraphFormat): void; + set(properties: Word.LinkFormat): void; + /** + * Breaks the link between the source file and the OLE object, picture, or linked field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + breakLink(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.ParagraphFormatLoadOptions): Word.ParagraphFormat; + load(options?: Word.Interfaces.LinkFormatLoadOptions): Word.LinkFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.ParagraphFormat; + load(propertyNames?: string | string[]): Word.LinkFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -103697,751 +104188,760 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.ParagraphFormat; + }): Word.LinkFormat; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ParagraphFormat; + track(): Word.LinkFormat; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ParagraphFormat; + untrack(): Word.LinkFormat; /** * 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.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.LinkFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LinkFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ParagraphFormatData; + toJSON(): Word.Interfaces.LinkFormatData; } /** - * Represents a contiguous area in a document. + * Contains a collection of {@link Word.Paragraph} objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - class Range extends OfficeExtension.ClientObject { + class List extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the collection of `ContentControl` objects in the range. + * Gets paragraphs in the list. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - readonly contentControls: Word.ContentControlCollection; + readonly paragraphs: Word.ParagraphCollection; /** - * Gets the collection of endnotes in the range. + * Gets the list's ID. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - readonly endnotes: Word.NoteItemCollection; + readonly id: number; /** - * Gets the collection of `Field` objects in the range. + * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - readonly fields: Word.FieldCollection; + readonly levelExistences: boolean[]; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - readonly font: Word.Font; + readonly levelTypes: Word.ListLevelType[]; /** - * Gets the collection of footnotes in the range. + * Gets the font of the bullet, number, or picture at the specified level in the list. * * @remarks - * [Api set: WordApi 1.5] - */ - readonly footnotes: Word.NoteItemCollection; - /** - * Gets a `FrameCollection` object that represents all the frames in the range. + * [Api set: WordApiDesktop 1.1] * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param level The level in the list. */ - readonly frames: Word.FrameCollection; + getLevelFont(level: number): Word.Font; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. + * Gets the paragraphs that occur at the specified level in the list. * * @remarks - * [Api set: WordApiDesktop 1.3] - */ - readonly hyperlinks: Word.HyperlinkCollection; - /** - * Gets the collection of `InlinePicture` objects in the range. + * [Api set: WordApi 1.3] * - * @remarks - * [Api set: WordApi 1.2] + * @param level The level in the list. */ - readonly inlinePictures: Word.InlinePictureCollection; + getLevelParagraphs(level: number): Word.ParagraphCollection; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Gets the Base64-encoded string representation of the picture at the specified level in the list. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] + * + * @param level The level in the list. */ - readonly listFormat: Word.ListFormat; + getLevelPicture(level: number): OfficeExtension.ClientResult; /** - * Gets the collection of `List` objects in the range. + * Gets the bullet, number, or picture at the specified level as a string. * * @remarks * [Api set: WordApi 1.3] + * + * @param level The level in the list. */ - readonly lists: Word.ListCollection; + getLevelString(level: number): OfficeExtension.ClientResult; /** - * Gets the collection of pages in the range. + * Inserts a paragraph at the specified location. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `start`, `end`, `before`, or `after`. */ - readonly pages: Word.PageCollection; + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; /** - * Gets the collection of `Paragraph` objects in the range. + * Resets the font of the bullet, number, or picture at the specified level in the list. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] * - * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + * @param level The level in the list. + * @param resetFontName Optional. Indicates whether to reset the font name. Default is `false` that indicates the font name remains unchanged. */ - readonly paragraphs: Word.ParagraphCollection; + resetLevelFont(level: number, resetFontName?: boolean): void; /** - * Gets the parent body of the range. + * Sets the alignment of the bullet, number, or picture at the specified level in the list. * * @remarks * [Api set: WordApi 1.3] - */ - readonly parentBody: Word.Body; - /** - * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. * - * @remarks - * [Api set: WordApi 1.1] + * @param level The level in the list. + * @param alignment The level alignment that must be `left`, `centered`, or `right`. */ - readonly parentContentControl: Word.ContentControl; + setLevelAlignment(level: number, alignment: Word.Alignment): void; /** - * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Sets the alignment of the bullet, number, or picture at the specified level in the list. * * @remarks * [Api set: WordApi 1.3] + * + * @param level The level in the list. + * @param alignment The level alignment that must be `left`, `centered`, or `right`. */ - readonly parentContentControlOrNullObject: Word.ContentControl; + setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void; /** - * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * Sets the bullet format at the specified level in the list. If the bullet is `custom`, the `charCode` is required. * * @remarks * [Api set: WordApi 1.3] + * + * @param level The level in the list. + * @param listBullet The bullet. + * @param charCode Optional. The bullet character's code value. Used only if the bullet is `custom`. + * @param fontName Optional. The bullet's font name. Used only if the bullet is `custom`. */ - readonly parentTable: Word.Table; + setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void; /** - * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Sets the bullet format at the specified level in the list. If the bullet is `custom`, the `charCode` is required. * * @remarks * [Api set: WordApi 1.3] + * + * @param level The level in the list. + * @param listBullet The bullet. + * @param charCode Optional. The bullet character's code value. Used only if the bullet is `custom`. + * @param fontName Optional. The bullet's font name. Used only if the bullet is `custom`. */ - readonly parentTableCell: Word.TableCell; + setLevelBullet(level: number, listBullet: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void; /** - * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Sets the two indents of the specified level in the list. * * @remarks * [Api set: WordApi 1.3] + * + * @param level The level in the list. + * @param textIndent The text indent in points. It is the same as paragraph left indent. + * @param bulletNumberPictureIndent The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. */ - readonly parentTableCellOrNullObject: Word.TableCell; + setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; /** - * Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Sets the numbering format at the specified level in the list. * * @remarks * [Api set: WordApi 1.3] + * + * @param level The level in the list. + * @param listNumbering The ordinal format. + * @param formatString Optional. The numbering string format defined as an array of strings or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ - readonly parentTableOrNullObject: Word.Table; + setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array): void; /** - * Gets the collection of sections in the range. + * Sets the numbering format at the specified level in the list. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param level The level in the list. + * @param listNumbering The ordinal format. + * @param formatString Optional. The numbering string format defined as an array of strings or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ - readonly sections: Word.SectionCollection; + setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array): void; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Sets the picture at the specified level in the list. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] + * + * @param level The level in the list. + * @param base64EncodedImage Optional. The Base64-encoded image to be set. If not given, the default picture is set. */ - readonly shading: Word.ShadingUniversal; + setLevelPicture(level: number, base64EncodedImage?: string): void; /** - * Gets the collection of `Shape` objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Sets the starting number at the specified level in the list. Default value is 1. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] * - * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + * @param level The level in the list. + * @param startingNumber The number to start with. */ - readonly shapes: Word.ShapeCollection; + setLevelStartingNumber(level: number, startingNumber: number): void; /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param options Provides options for which properties of the object to load. */ - readonly tableColumns: Word.TableColumnCollection; + load(options?: Word.Interfaces.ListLoadOptions): Word.List; /** - * Gets the collection of `Table` objects in the range. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly tables: Word.TableCollection; + load(propertyNames?: string | string[]): Word.List; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - hasNoProofing: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.List; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.List; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.List; + /** + * 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.List` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListData; + } + /** + * Contains a collection of {@link Word.List} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + class ListCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.List[]; + /** + * Gets a list by its identifier. Throws an `ItemNotFound` error if there isn't a list with the identifier in this collection. * * @remarks * [Api set: WordApi 1.3] + * + * @param id A list identifier. */ - hyperlink: string; + getById(id: number): Word.List; /** - * Checks whether the range length is zero. + * Gets a list by its identifier. If there isn't a list with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] + * + * @param id A list identifier. */ - readonly isEmpty: boolean; + getByIdOrNullObject(id: number): Word.List; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Gets the first list in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - languageDetected: boolean; + getFirst(): Word.List; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Gets the first list in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + getFirstOrNullObject(): Word.List; /** - * Specifies an East Asian language for the range. + * Gets a `List` object by its ID. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param id The list's ID. */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + getItem(id: number): Word.List; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param options Provides options for which properties of the object to load. */ - languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + load(options?: Word.Interfaces.ListCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListCollection; /** - * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - style: string; + load(propertyNames?: string | string[]): Word.ListCollection; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListCollection; /** - * Gets the text of the range. - * - * @remarks - * [Api set: WordApi 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - readonly text: string; + track(): Word.ListCollection; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Range): void; + untrack(): Word.ListCollection; /** - * Clears the contents of the `Range` object. The user can perform the undo operation on the cleared content. + * 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.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListCollectionData; + } + /** + * Represents the paragraph list item format. + * + * @remarks + * [Api set: WordApi 1.3] + */ + class ListItem extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the level of the item in the list. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - clear(): void; + level: number; /** - * Compares this range's location with another range's location. + * Gets the list item bullet, number, or picture as a string. * * @remarks * [Api set: WordApi 1.3] - * - * @param range The range to compare with this range. */ - compareLocationWith(range: Word.Range): OfficeExtension.ClientResult; + readonly listString: string; /** - * Deletes the range and its content from the document. + * Gets the list item order number in relation to its siblings. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - delete(): void; + readonly siblingIndex: number; /** - * Analyzes the range text to determine the language that it's written in. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - detectLanguage(): OfficeExtension.ClientResult; + set(properties: Interfaces.ListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListItem): void; /** - * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges don't have a union. + * Gets the list item parent, or the closest ancestor if the parent doesn't exist. Throws an `ItemNotFound` error if the list item has no ancestor. * * @remarks * [Api set: WordApi 1.3] * - * @param range Another range. + * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is `false` that specifies to get the lowest ancestor. */ - expandTo(range: Word.Range): Word.Range; + getAncestor(parentOnly?: boolean): Word.Paragraph; /** - * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. If the two ranges don't have a union, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the list item parent, or the closest ancestor if the parent doesn't exist. If the list item has no ancestor, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] * - * @param range Another range. + * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is `false` that specifies to get the lowest ancestor. */ - expandToOrNullObject(range: Word.Range): Word.Range; + getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph; /** - * Gets the names all bookmarks in or overlapping the range. A bookmark is hidden if its name starts with the underscore character. + * Gets all descendant list items of the list item. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] * - * @param includeHidden Optional. Indicates whether to include hidden bookmarks. Default is `false` which indicates that the hidden bookmarks are excluded. - * @param includeAdjacent Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is `false` which indicates that the adjacent bookmarks are excluded. + * @param directChildrenOnly Optional. Specifies only the list item's direct children will be returned. The default is `false` that indicates to get all descendant items. */ - getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult; + getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection; /** - * Gets comments associated with the range. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.4] - * @returns A `CommentCollection` object that contains all the comments associated with the range. + * @param options Provides options for which properties of the object to load. */ - getComments(): Word.CommentCollection; + load(options?: Word.Interfaces.ListItemLoadOptions): Word.ListItem; /** - * Gets the currently supported content controls in the range. - * - * @remarks - * [Api set: WordApi 1.5] - * - * **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param options Optional. Options that define which content controls are returned. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + load(propertyNames?: string | string[]): Word.ListItem; /** - * Gets an HTML representation of the `Range` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - getHtml(): OfficeExtension.ClientResult; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListItem; /** - * Gets hyperlink child ranges within the range. - * - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - getHyperlinkRanges(): Word.RangeCollection; + track(): Word.ListItem; /** - * Gets the next text range by using punctuation marks and other ending marks. Throws an `ItemNotFound` error if this text range is the last one. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param endingMarks The punctuation marks and other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is `false` which indicates that spacing characters at the start and end of the range are included. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range; + untrack(): Word.ListItem; /** - * Gets the next text range by using punctuation marks and other ending marks. If this text range is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * 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.ListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListItemData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListItemData; + } + /** + * Represents a list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + class ListLevel extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. * * @remarks - * [Api set: WordApi 1.3] - * - * @param endingMarks The punctuation marks and other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is `false` which indicates that spacing characters at the start and end of the range are included. + * [Api set: WordApiDesktop 1.1] */ - getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range; + readonly font: Word.Font; /** - * Gets the OOXML representation of the `Range` object. + * Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - getOoxml(): OfficeExtension.ClientResult; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Clones the `Range` object, or gets the starting or ending point of the range as a new range. + * Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks - * [Api set: WordApi 1.3] - * - * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `after`, or `content`. + * [Api set: WordApiDesktop 1.1] */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; + linkedStyle: string; /** - * Gets reviewed text based on ChangeTrackingVersion selection. + * Specifies the number format for the list level. * * @remarks - * [Api set: WordApi 1.4] - * - * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. + * [Api set: WordApiDesktop 1.1] */ - getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; + numberFormat: string; /** - * Gets reviewed text based on ChangeTrackingVersion selection. + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks - * [Api set: WordApi 1.4] - * - * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. + * [Api set: WordApiDesktop 1.1] */ - getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; + numberPosition: number; /** - * Gets the text child ranges in the range by using punctuation marks and other ending marks. + * Specifies the number style for the `ListLevel` object. * * @remarks - * [Api set: WordApi 1.3] - * - * @param endingMarks The punctuation marks and other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * [Api set: WordApiDesktop 1.1] */ - getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; + numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Gets the collection of the `TrackedChange` objects in the range. + * Specifies the list level that must appear before it restarts numbering at 1. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.1] */ - getTrackedChanges(): Word.TrackedChangeCollection; + resetOnHigher: number; /** - * Highlights the range temporarily without changing document content. - To highlight the text permanently, set the range's `font.highlightColor`. + * Specifies the starting number for the `ListLevel` object. * * @remarks - * [Api set: WordApi 1.8] + * [Api set: WordApiDesktop 1.1] */ - highlight(): void; + startAt: number; /** - * Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first. + * Specifies the tab position for the `ListLevel` object. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The conditions of inserting a bookmark are similar to doing so in the Word UI. To learn more about managing bookmarks in the Word UI, see {@link https://support.microsoft.com/office/f68d781f-0150-4583-a90e-a4009d99c2a0 | Add or delete bookmarks in a Word document or Outlook message}. - * - * @param name The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + * [Api set: WordApiDesktop 1.1] */ - insertBookmark(name: string): void; + tabPosition: number; /** - * Inserts a break at the specified location in the main document. + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks - * [Api set: WordApi 1.1] - * - * @param breakType The break type to add. - * @param insertLocation The value must be `before` or `after`. + * [Api set: WordApiDesktop 1.1] */ - insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + textPosition: number; /** - * Inserts a floating canvas in front of text with its anchor at the beginning of the range. + * Specifies the character inserted after the number for the list level. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param insertShapeOptions Optional. The location and size of the canvas. The default location and size is (0, 0, 300, 200). + * [Api set: WordApiDesktop 1.1] */ - insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + trailingCharacter: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; /** - * Insert a comment on the range. - * - * @remarks - * [Api set: WordApi 1.4] - * - * @param commentText The comment text to be inserted. - * @returns The `Comment` object that was inserted. + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - insertComment(commentText: string): Word.Comment; + set(properties: Interfaces.ListLevelUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListLevel): void; /** - * Wraps the `Range` object with a content control. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. - * `dropDownList` and `comboBox` support was added in WordApi 1.9. Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param contentControlType Optional. Content control type to insert. Must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. The default is `richText`. + * @param options Provides options for which properties of the object to load. */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl; + load(options?: Word.Interfaces.ListLevelLoadOptions): Word.ListLevel; /** - * Inserts an endnote. The endnote reference is placed after the range. - * - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param insertText Optional. Text to be inserted into the endnote body. The default is "". + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - insertEndnote(insertText?: string): Word.NoteItem; + load(propertyNames?: string | string[]): Word.ListLevel; /** - * Inserts a field at the specified location. - * - * @remarks - * [Api set: WordApi 1.5] - * - * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. - * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param insertLocation The location relative to the range where the field will be inserted. The value must be `replace`, `start`, `end`, `before`, or `after`. - * @param fieldType Optional. Can be any `FieldType` value. The default value is `empty`. - * @param text Optional. Additional properties or options if needed for specified field type. - * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListLevel; /** - * Inserts a field at the specified location. - * - * @remarks - * [Api set: WordApi 1.5] - * - * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. - * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. - * - * @param insertLocation The location relative to the range where the field will be inserted. The value must be `replace`, `start`, `end`, `before`, or `after`. - * @param fieldType Optional. Can be any `FieldType` value. The default value is `empty`. - * @param text Optional. Additional properties or options if needed for specified field type. - * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field; + track(): Word.ListLevel; /** - * Inserts a document at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. - * - * @param base64File The Base64-encoded content of a .docx file. - * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + untrack(): Word.ListLevel; /** - * Inserts a footnote. The footnote reference is placed after the range. + * 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.ListLevel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListLevelData; + } + /** + * Contains a collection of {@link Word.ListLevel} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + class ListLevelCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.ListLevel[]; + /** + * Gets the first list level in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.5] - * - * @param insertText Optional. Text to be inserted into the footnote body. The default is "". + * [Api set: WordApiDesktop 1.1] */ - insertFootnote(insertText?: string): Word.NoteItem; + getFirst(): Word.ListLevel; /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the range. + * Gets the first list level in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param geometricShapeType The geometric type of the shape to insert. - * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). + * [Api set: WordApiDesktop 1.1] */ - insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + getFirstOrNullObject(): Word.ListLevel; /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param geometricShapeType The geometric type of the shape to insert. - * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). + * @param options Provides options for which properties of the object to load. */ - insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + load(options?: Word.Interfaces.ListLevelCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListLevelCollection; /** - * Inserts HTML at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param html The HTML to be inserted. - * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + load(propertyNames?: string | string[]): Word.ListLevelCollection; /** - * Inserts a picture at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param base64EncodedImage The Base64-encoded image to be inserted. - * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListLevelCollection; /** - * Inserts OOXML at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] - * - * @param ooxml The OOXML to be inserted. - * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + track(): Word.ListLevelCollection; /** - * Inserts a paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] - * - * @param paragraphText The paragraph text to be inserted. - * @param insertLocation The value must be `before` or `after`. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + untrack(): Word.ListLevelCollection; /** - * Inserts a floating picture in front of text with its anchor at the beginning of the range. + * 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.ListLevelCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListLevelCollectionData; + } + /** + * Represents a list template. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + class ListTemplate extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets a `ListLevelCollection` object that represents all the levels for the list template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param base64EncodedImage The Base64-encoded image to be inserted. - * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. + * [Api set: WordApiDesktop 1.1] */ - insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + readonly listLevels: Word.ListLevelCollection; /** - * Inserts a table with the specified number of rows and columns. + * Specifies the name of the list template. * * @remarks - * [Api set: WordApi 1.3] - * - * @param rowCount The number of rows in the table. - * @param columnCount The number of columns in the table. - * @param insertLocation The value must be `before` or `after`. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * [Api set: WordApiDesktop 1.4] */ - insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + name: string; /** - * Inserts text at the specified location. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi 1.1] - * - * @param text Text to be inserted. - * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. + * [Api set: WordApiDesktop 1.1] */ - insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + outlineNumbered: boolean; /** - * Inserts a floating text box in front of text with its anchor at the beginning of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ListTemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListTemplate): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param text Optional. The text to insert into the text box. - * @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100). + * @param options Provides options for which properties of the object to load. */ - insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + load(options?: Word.Interfaces.ListTemplateLoadOptions): Word.ListTemplate; /** - * Returns a new range as the intersection of this range with another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges aren't overlapped or adjacent. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ListTemplate; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param range Another range. + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - intersectWith(range: Word.Range): Word.Range; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListTemplate; /** - * Returns a new range as the intersection of this range with another range. This range isn't changed. If the two ranges aren't overlapped or adjacent, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListTemplate; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListTemplate; + /** + * 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.ListTemplate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListTemplateData; + } + /** + * Represents a footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + class NoteItem extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. * * @remarks - * [Api set: WordApi 1.3] - * - * @param range Another range. + * [Api set: WordApi 1.5] */ - intersectWithOrNullObject(range: Word.Range): Word.Range; + readonly body: Word.Body; /** - * Removes the highlight added by the `highlight` method if any. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi 1.8] + * [Api set: WordApi 1.5] */ - removeHighlight(): void; + readonly reference: Word.Range; /** - * Performs a search with the specified search options on the scope of the `Range` object. The search results are a collection of `Range` objects. + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi 1.1] - * - * @param searchText The search text. - * @param searchOptions Optional. Options for the search. + * [Api set: WordApi 1.5] */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + readonly type: Word.NoteItemType | "Footnote" | "Endnote"; /** - * Selects and navigates the Word UI to the range. + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.NoteItem): void; + /** + * Deletes the note item. * * @remarks - * [Api set: WordApi 1.1] - * - * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + * [Api set: WordApi 1.5] */ - select(selectionMode?: Word.SelectionMode): void; + delete(): void; /** - * Selects and navigates the Word UI to the range. + * Gets the next note item of the same type. Throws an `ItemNotFound` error if this note item is the last one. * * @remarks - * [Api set: WordApi 1.1] - * - * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + * [Api set: WordApi 1.5] */ - select(selectionMode?: "Select" | "Start" | "End"): void; + getNext(): Word.NoteItem; /** - * Splits the range into child ranges by using delimiters. + * Gets the next note item of the same type. If this note item is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.3] - * - * @param delimiters The delimiters as an array of strings. - * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is `false` which indicates that the paragraph boundaries are also used as delimiters. - * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is `false` which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * [Api set: WordApi 1.5] */ - split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; + getNextOrNullObject(): Word.NoteItem; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.RangeLoadOptions): Word.Range; + load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Range; + load(propertyNames?: string | string[]): Word.NoteItem; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -104450,257 +104950,218 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Range; + }): Word.NoteItem; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Range; + track(): Word.NoteItem; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Range; + untrack(): Word.NoteItem; /** * 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.Range` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.NoteItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.RangeData; + toJSON(): Word.Interfaces.NoteItemData; } /** - * Contains a collection of {@link Word.Range} objects. + * Contains a collection of {@link Word.NoteItem} objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - class RangeCollection extends OfficeExtension.ClientObject { + class NoteItemCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.Range[]; + readonly items: Word.NoteItem[]; /** - * Gets the first range in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the first note item in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - getFirst(): Word.Range; + getFirst(): Word.NoteItem; /** - * Gets the first range in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the first note item in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - getFirstOrNullObject(): Word.Range; + getFirstOrNullObject(): Word.NoteItem; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.RangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeCollection; + load(options?: Word.Interfaces.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.RangeCollection; + load(propertyNames?: string | string[]): Word.NoteItemCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RangeCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.NoteItemCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.RangeCollection; + track(): Word.NoteItemCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.RangeCollection; + untrack(): Word.NoteItemCollection; /** * 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.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.RangeCollectionData; + toJSON(): Word.Interfaces.NoteItemCollectionData; } /** - * Specifies the options to determine location and size when inserting a shape. + * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - interface InsertShapeOptions { + class OleFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * If provided, specifies the height of the shape being inserted. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - height?: number; + classType: string; /** - * If provided, specifies the left position of the shape being inserted. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - left?: number; + iconIndex: number; /** - * If provided, specifies the top position of the shape being inserted. + * Specifies the text displayed below the icon for the OLE object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - top?: number; + iconLabel: string; /** - * If provided, specifies the width of the shape being inserted. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** - * Specifies the options to determine what to copy when inserting a file. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface InsertFileOptions { + iconName: string; /** - * If provided, specifies whether the change tracking mode status from the source document should be imported. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - importChangeTrackingMode?: boolean; + readonly iconPath: string; /** - * If provided, specifies whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. + * Gets whether the specified object is displayed as an icon. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - importCustomProperties?: boolean; + readonly isDisplayedAsIcon: boolean; /** - * If provided, specifies whether the custom XML parts from the source document should be imported. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - importCustomXmlParts?: boolean; + isFormattingPreservedOnUpdate: boolean; /** - * If provided, specifies whether to import the Different Odd and Even Pages setting for the header and footer from the source document. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.4] */ - importDifferentOddEvenPages?: boolean; + readonly label: string; /** - * If provided, specifies whether the page color and other background information from the source document should be imported. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - importPageColor?: boolean; + readonly progId: string; /** - * If provided, specifies whether the paragraph spacing from the source document should be imported. - * - * @remarks - * [Api set: WordApi 1.5] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - importParagraphSpacing?: boolean; + set(properties: Interfaces.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.OleFormat): void; /** - * If provided, specifies whether the styles from the source document should be imported. + * Activates the `OleFormat` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - importStyles?: boolean; + activate(): void; /** - * If provided, specifies whether the theme from the source document should be imported. + * Sets the Windows registry value that determines the default application used to activate the specified OLE object. * * @remarks - * [Api set: WordApi 1.5] - */ - importTheme?: boolean; - } - /** - * Specifies the options to be included in a search operation. - To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. - * - * @remarks - * [Api set: WordApi 1.1] - */ - class SearchOptions extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** - * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. + * [Api set: WordApiDesktop 1.4] * - * @remarks - * [Api set: WordApi 1.1] + * @param classType The class type to activate as. */ - ignorePunct: boolean; + activateAs(classType: string): void; /** - * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. + * Requests that the OLE object perform one of its available verbs. * * @remarks - * [Api set: WordApi 1.1] - */ - ignoreSpace: boolean; - /** - * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. + * [Api set: WordApiDesktop 1.4] * - * @remarks - * [Api set: WordApi 1.1] + * @param verbIndex Optional. The index of the verb to perform. */ - matchCase: boolean; + doVerb(verbIndex: Word.OleVerb): void; /** - * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. + * Requests that the OLE object perform one of its available verbs. * * @remarks - * [Api set: WordApi 1.1] - */ - matchPrefix: boolean; - /** - * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. + * [Api set: WordApiDesktop 1.4] * - * @remarks - * [Api set: WordApi 1.1] + * @param verbIndex Optional. The index of the verb to perform. */ - matchSuffix: boolean; + doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void; /** - * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. + * Opens the OLE object for editing in the application it was created in. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - matchWholeWord: boolean; + edit(): void; /** - * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. + * Opens the `OleFormat` object. * * @remarks - * [Api set: WordApi 1.1] - */ - matchWildcards: boolean; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.SearchOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.SearchOptions): void; + open(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.SearchOptionsLoadOptions): Word.SearchOptions; + load(options?: Word.Interfaces.OleFormatLoadOptions): Word.OleFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.SearchOptions; + load(propertyNames?: string | string[]): Word.OleFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -104709,204 +105170,93 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.SearchOptions; - /** - * Create a new instance of the `Word.SearchOptions` object. - */ - static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions; - /** - * 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.SearchOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SearchOptionsData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.SearchOptionsData; - } - /** - * Specifies the options to be included in a {@link Word.Paragraph | Paragraph.getText} operation. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface GetTextOptions { - /** - * If provided, specifies whether to include hidden text in the result of the `Paragraph.getText` method. The default value is `false`. - * - * @remarks - * [Api set: WordApi 1.7] - */ - includeHiddenText?: boolean; - /** - * If provided, specifies whether to include text marked as deleted in the result of the `Paragraph.getText` method. The default value is `false`. - * - * @remarks - * [Api set: WordApi 1.7] - */ - includeTextMarkedAsDeleted?: boolean; - } - /** - * Specifies the options to be included in a compare document operation. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface DocumentCompareOptions { - /** - * If provided, specifies whether to add the document to the list of recently used files on the **File** menu. The default value is `true`. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - addToRecentFiles?: boolean; - /** - * If provided, specifies the reviewer name associated with the differences generated by the comparison. - If unspecified, the value defaults to the author name of the revised document or the string `Comparison` if no author information is present. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - authorName?: string; - /** - * If provided, specifies the target document for the comparison. Default value is `compareTargetCurrent`. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"; - /** - * If provided, specifies whether the comparison should include detection of format changes. The default value is `true`. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - detectFormatChanges?: boolean; + }): Word.OleFormat; /** - * If provided, specifies whether to compare the documents without notifying a user of problems. The default value is `false`. - * - * @remarks - * [Api set: WordApiDesktop 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - ignoreAllComparisonWarnings?: boolean; + track(): Word.OleFormat; /** - * If provided, specifies whether to remove date and time stamp information from tracked changes in the returned `Document` object. The default value is `false`. - * - * @remarks - * [Api set: WordApiDesktop 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - removeDateAndTime?: boolean; + untrack(): Word.OleFormat; /** - * If provided, specifies whether to remove all user information from comments, revisions, and the properties dialog box in the returned `Document` object. The default value is `false`. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - removePersonalInformation?: boolean; + * 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.OleFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.OleFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.OleFormatData; } /** - * Represents a section in a Word document. + * Represents a page in the document. `Page` objects manage the page layout and content. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - class Section extends OfficeExtension.ClientObject { + class Page extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ - readonly body: Word.Body; - /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - readonly borders: Word.BorderUniversalCollection; - /** - * Returns a `PageSetup` object that's associated with the section. + * Gets a `BreakCollection` object that represents the breaks on the page. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly pageSetup: Word.PageSetup; + readonly breaks: Word.BreakCollection; /** - * Specifies if the section is protected for forms. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApiDesktop 1.3] - */ - protectedForForms: boolean; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.SectionUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Section): void; + readonly height: number; /** - * Gets one of the section's footers. + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApi 1.1] - * - * @param type The type of footer to return. This value must be: `primary`, `firstPage`, or `evenPages`. + * [Api set: WordApiDesktop 1.2] */ - getFooter(type: Word.HeaderFooterType): Word.Body; + readonly index: number; /** - * Gets one of the section's footers. + * Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.1] - * - * @param type The type of footer to return. This value must be: `primary`, `firstPage`, or `evenPages`. + * [Api set: WordApiDesktop 1.2] */ - getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + readonly width: number; /** - * Gets one of the section's headers. + * Gets the next page in the pane. Throws an `ItemNotFound` error if this page is the last one. * * @remarks - * [Api set: WordApi 1.1] - * - * @param type The type of header to return. This value must be: `primary`, `firstPage`, or `evenPages`. + * [Api set: WordApiDesktop 1.2] */ - getHeader(type: Word.HeaderFooterType): Word.Body; + getNext(): Word.Page; /** - * Gets one of the section's headers. + * Gets the next page. If this page is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.1] - * - * @param type The type of header to return. This value must be: `primary`, `firstPage`, or `evenPages`. + * [Api set: WordApiDesktop 1.2] */ - getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + getNextOrNullObject(): Word.Page; /** - * Gets the next section. Throws an `ItemNotFound` error if this section is the last one. + * Gets the whole page, or the starting or ending point of the page, as a range. * * @remarks - * [Api set: WordApi 1.3] - */ - getNext(): Word.Section; - /** - * Gets the next section. If this section is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * [Api set: WordApiDesktop 1.2] * - * @remarks - * [Api set: WordApi 1.3] + * @param rangeLocation Optional. The range location must be `whole`, `start`, or `end`. */ - getNextOrNullObject(): Word.Section; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.SectionLoadOptions): Word.Section; + load(options?: Word.Interfaces.PageLoadOptions): Word.Page; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Section; + load(propertyNames?: string | string[]): Word.Page; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -104915,128 +105265,134 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Section; + }): Word.Page; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Section; + track(): Word.Page; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Section; + untrack(): Word.Page; /** * 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.Section` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.SectionData; + toJSON(): Word.Interfaces.PageData; } /** - * Contains the collection of the document's {@link Word.Section} objects. + * Represents the collection of {@link Word.Page} objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - class SectionCollection extends OfficeExtension.ClientObject { + class PageCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.Section[]; + readonly items: Word.Page[]; /** - * Gets the first section in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the first page in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - getFirst(): Word.Section; + getFirst(): Word.Page; /** - * Gets the first section in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the first page in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - getFirstOrNullObject(): Word.Section; + getFirstOrNullObject(): Word.Page; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.SectionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SectionCollection; + load(options?: Word.Interfaces.PageCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PageCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.SectionCollection; + load(propertyNames?: string | string[]): Word.PageCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SectionCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.PageCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.SectionCollection; + track(): Word.PageCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.SectionCollection; + untrack(): Word.PageCollection; /** * 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.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.SectionCollectionData; + toJSON(): Word.Interfaces.PageCollectionData; } /** - * Represents a setting of the add-in. + * Represents a window pane. The `Pane` object is a member of the pane collection. The pane collection includes all the window panes for a single window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - class Setting extends OfficeExtension.ClientObject { + class Pane extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the key of the setting. + * Gets the collection of pages in the pane. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - readonly key: string; + readonly pages: Word.PageCollection; /** - * Specifies the value of the setting. + * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - value: any; + readonly pagesEnclosingViewport: Word.PageCollection; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Returns a `Selection` object that represents the current selection in the pane. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.SettingUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Setting): void; + readonly selection: Word.Selection; /** - * Deletes the setting. + * Gets the next pane in the window. Throws an `ItemNotFound` error if this pane is the last one. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - delete(): void; + getNext(): Word.Pane; + /** + * Gets the next pane. If this pane is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + getNextOrNullObject(): Word.Pane; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.SettingLoadOptions): Word.Setting; + load(options?: Word.Interfaces.PaneLoadOptions): Word.Pane; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Setting; + load(propertyNames?: string | string[]): Word.Pane; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -105045,487 +105401,488 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Setting; + }): Word.Pane; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Setting; + track(): Word.Pane; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Setting; + untrack(): Word.Pane; /** * 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.Setting` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.SettingData; + toJSON(): Word.Interfaces.PaneData; } /** - * Contains the collection of {@link Word.Setting} objects. + * Represents the collection of {@link Word.Pane} objects. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - class SettingCollection extends OfficeExtension.ClientObject { + class PaneCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.Setting[]; - /** - * Creates a new setting or sets an existing setting. - * - * @remarks - * [Api set: WordApi 1.4] - * - * @param key The setting's key, which is case-sensitive. - * @param value The setting's value. - */ - add(key: string, value: any): Word.Setting; - /** - * Deletes all settings in this add-in. - * - * @remarks - * [Api set: WordApi 1.4] - */ - deleteAll(): void; - /** - * Gets the number of items in the collection. - * - * @remarks - * [Api set: WordApi 1.4] - */ - getCount(): OfficeExtension.ClientResult; + readonly items: Word.Pane[]; /** - * Gets a `Setting` object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. + * Gets the first pane in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.4] - * - * @param key The key that identifies the `Setting` object. + * [Api set: WordApiDesktop 1.2] */ - getItem(key: string): Word.Setting; + getFirst(): Word.Pane; /** - * Gets a `Setting` object by its key, which is case-sensitive. If the setting doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the first pane in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.4] - * - * @param key The key that identifies the `Setting` object. + * [Api set: WordApiDesktop 1.2] */ - getItemOrNullObject(key: string): Word.Setting; + getFirstOrNullObject(): Word.Pane; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.SettingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SettingCollection; + load(options?: Word.Interfaces.PaneCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PaneCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.SettingCollection; + load(propertyNames?: string | string[]): Word.PaneCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SettingCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.PaneCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.SettingCollection; + track(): Word.PaneCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.SettingCollection; + untrack(): Word.PaneCollection; /** * 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.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.SettingCollectionData; + toJSON(): Word.Interfaces.PaneCollectionData; } /** - * Contains a collection of {@link Word.Style} objects. + * The options that define whether to save changes before closing and whether to route the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - class StyleCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.Style[]; + interface WindowCloseOptions { /** - * Get the `Style` object by its name. + * If provided, specifies whether to route the document to the next recipient. If the document doesn't have a routing slip attached, this property is ignored. * * @remarks - * [Api set: WordApi 1.5] - * - * @param name The style name. + * [Api set: WordApiDesktop 1.4] */ - getByName(name: string): Word.Style; + routeDocument?: boolean; /** - * If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + * If provided, specifies the save action for the document. For available values, see {@link Word.SaveConfiguration}. * * @remarks - * [Api set: WordApi 1.5] - * - * @param name The style name. + * [Api set: WordApiDesktop 1.4] */ - getByNameOrNullObject(name: string): Word.Style; + saveChanges?: Word.SaveConfiguration | "DoNotSaveChanges" | "SaveChanges" | "PromptToSaveChanges"; + } + /** + * The options that scrolls a window or pane by the specified number of units defined by the calling method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface WindowScrollOptions { /** - * Returns the number of items in the collection. + * If provided, specifies the number of units to scroll the window down. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - getCount(): OfficeExtension.ClientResult; + down?: number; /** - * Gets a `Style` object by its index in the collection. + * If provided, specifies the number of screens to scroll the window to the left. + If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. * * @remarks - * [Api set: WordApi 1.5] - * - * @param index The location of a `Style` object. + * [Api set: WordApiDesktop 1.4] */ - getItem(index: number): Word.Style; + left?: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the number of screens to scroll the window to the right. + If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.StyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.StyleCollection; + right?: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the number of units to scroll the window up. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.StyleCollection; + up?: number; + } + /** + * The options for scrolling through the specified pane or window page by page. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface WindowPageScrollOptions { /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the number of pages to scroll the window down. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.StyleCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.StyleCollection; + down?: number; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * If provided, specifies the number of pages to scroll the window up. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.StyleCollection; - /** - * 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.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.StyleCollectionData; + up?: number; } /** - * Represents a style in a Word document. + * Represents the window that displays the document. A window can be split to contain multiple reading panes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - class Style extends OfficeExtension.ClientObject { + class Window extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies a `BorderCollection` object that represents all the borders for the style. + * Gets the active pane in the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - readonly borders: Word.BorderCollection; + readonly activePane: Word.Pane; /** - * Gets a `Font` object that represents the character formatting of the style. + * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly font: Word.Font; + readonly next: Word.Window; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Gets the collection of panes in the window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - readonly frame: Word.Frame; + readonly panes: Word.PaneCollection; /** - * Specifies a link between a paragraph and a character style. + * Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - linkStyle: Word.Style; + readonly previous: Word.Window; /** - * Gets a `ListTemplate` object that represents the list formatting for the style. + * Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - readonly listTemplate: Word.ListTemplate; + readonly view: Word.View; /** - * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly paragraphFormat: Word.ParagraphFormat; + areRulersDisplayed: boolean; /** - * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - readonly shading: Word.Shading; + readonly areScreenTipsDisplayed: boolean; /** - * Gets a `TableStyle` object representing style properties that can be applied to a table. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - readonly tableStyle: Word.TableStyle; + areThumbnailsDisplayed: boolean; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - automaticallyUpdate: boolean; + caption: string; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApiDesktop 1.4] */ - baseStyle: string; + readonly height: number; /** - * Gets whether the style is a built-in style. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly builtIn: boolean; + horizontalPercentScrolled: number; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - hasProofing: boolean; + imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** - * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * Gets the position of an item in a collection. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly inUse: boolean; + readonly index: number; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies whether the window is active. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + readonly isActive: boolean; /** - * Specifies an East Asian language for the style. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isDocumentMapVisible: boolean; /** - * Gets whether the style is a linked style that can be used for both paragraph and character formatting. + * Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly linked: boolean; + isEnvelopeVisible: boolean; /** - * Returns the list level for the style. + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly listLevelNumber: number; + isHorizontalScrollBarDisplayed: boolean; /** - * Specifies whether the style cannot be changed or edited. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - locked: boolean; + isLeftScrollBarDisplayed: boolean; /** - * Gets the name of the style in the language of the user. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly nameLocal: string; + isRightRulerDisplayed: boolean; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. + * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] + */ + isSplit: boolean; + /** + * Specifies whether a vertical ruler is displayed for the window or pane. * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - nextParagraphStyle: string; + isVerticalRulerDisplayed: boolean; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - noSpaceBetweenParagraphsOfSameStyle: boolean; + isVerticalScrollBarDisplayed: boolean; /** - * Specifies the priority. + * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - priority: number; + isVisible: boolean; /** - * Specifies whether the style corresponds to an available quick style. + * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - quickStyle: boolean; + readonly left: number; /** - * Gets the style type. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** - * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. + * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - unhideWhenUsed: boolean; + splitVertical: number; /** - * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies the width of the style area in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - visibility: boolean; + styleAreaWidth: number; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies the vertical position of the document window, in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Style): void; + readonly top: number; /** - * Deletes the style. + * Gets the window type. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - delete(): void; + readonly type: Word.WindowType | "Document" | "Template"; /** - * Links this style to a list template so that the style's formatting can be applied to lists. + * Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + */ + readonly usableHeight: number; + /** + * Gets the width (in points) of the active working area in the document window. * - * @param listTemplate A `ListTemplate` to link to the style. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - linkToListTemplate(listTemplate: Word.ListTemplate): void; + readonly usableWidth: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the vertical scroll position as a percentage of the document length. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.StyleLoadOptions): Word.Style; + verticalPercentScrolled: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the width of the document window, in points. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.Style; + readonly width: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets an integer that represents the position of the window. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Style; + readonly windowNumber: number; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - track(): Word.Style; + set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Window): void; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Activates the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.Style; + activate(): void; /** - * 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.Style` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.StyleData; - } - /** - * Represents the `Shading` object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - class Shading extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + * Closes the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. The options that define whether to save changes before closing and whether to route the document. + */ + close(options?: Word.WindowCloseOptions): void; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Scrolls the window by the specified number of screens. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. The options for scrolling the window by the specified number of screens. If no options are specified, the window is scrolled down one screen. */ - backgroundPatternColor: string; + largeScroll(options?: Word.WindowScrollOptions): void; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Scrolls through the window page by page. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. The options for scrolling through the window page by page. */ - foregroundPatternColor: string; + pageScroll(options?: Word.WindowPageScrollOptions): void; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Sets the focus of the document window to the body of an email message. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + setFocus(): void; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Scrolls the window by the specified number of lines. A "line" corresponds to the distance scrolled by clicking the scroll arrow on the scroll bar once. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. The options for scrolling the window by the specified number of lines. If no options are specified, the window is scrolled down by one line. */ - set(properties: Interfaces.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Shading): void; + smallScroll(options?: Word.WindowScrollOptions): void; + /** + * Shows or hides the ribbon. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + toggleRibbon(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading; + load(options?: Word.Interfaces.WindowLoadOptions): Word.Window; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Shading; + load(propertyNames?: string | string[]): Word.Window; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -105534,529 +105891,672 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Shading; + }): Word.Window; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Shading; + track(): Word.Window; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Shading; + untrack(): Word.Window; /** * 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.Shading` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ShadingData; + toJSON(): Word.Interfaces.WindowData; } /** - * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. + * Represents the collection of {@link Word.Window} objects. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - class ShadingUniversal extends OfficeExtension.ClientObject { + class WindowCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Window[]; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - backgroundPatternColor: string; - /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - backgroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; - /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - foregroundPatternColor: string; - /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Gets the first window in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - foregroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + getFirst(): Word.Window; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Gets the first window in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] - */ - texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ShadingUniversalUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShadingUniversal): void; + getFirstOrNullObject(): Word.Window; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.ShadingUniversalLoadOptions): Word.ShadingUniversal; + load(options?: Word.Interfaces.WindowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.WindowCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.ShadingUniversal; + load(propertyNames?: string | string[]): Word.WindowCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShadingUniversal; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.WindowCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ShadingUniversal; + track(): Word.WindowCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ShadingUniversal; + untrack(): Word.WindowCollection; /** * 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.ShadingUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingUniversalData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.ShadingUniversalData; + toJSON(): Word.Interfaces.WindowCollectionData; } /** - * Represents a table in a Word document. + * Represents a single paragraph in a selection, range, content control, or document body. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - class Table extends OfficeExtension.ClientObject { + class Paragraph extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the collection of endnotes in the table. + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly borders: Word.BorderUniversalCollection; + /** + * Gets the collection of `ContentControl` objects in the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly contentControls: Word.ContentControlCollection; + /** + * Gets the collection of endnotes in the paragraph. * * @remarks * [Api set: WordApi 1.5] */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of `Field` objects in the table. + * Gets the collection of fields in the paragraph. * * @remarks * [Api set: WordApi 1.4] */ readonly fields: Word.FieldCollection; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ readonly font: Word.Font; /** - * Gets the collection of footnotes in the table. + * Gets the collection of footnotes in the paragraph. * * @remarks * [Api set: WordApi 1.5] */ readonly footnotes: Word.NoteItemCollection; /** - * Gets the parent body of the table. + * Gets the collection of `InlinePicture` objects in the paragraph. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly inlinePictures: Word.InlinePictureCollection; + /** + * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentBody: Word.Body; + readonly list: Word.List; /** - * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly listItem: Word.ListItem; + /** + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly listItemOrNullObject: Word.ListItem; + /** + * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly listOrNullObject: Word.List; + /** + * Gets the parent body of the paragraph. * * @remarks * [Api set: WordApi 1.3] */ + readonly parentBody: Word.Body; + /** + * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ readonly parentContentControl: Word.ContentControl; /** - * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] */ readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks * [Api set: WordApi 1.3] */ readonly parentTable: Word.Table; /** - * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks * [Api set: WordApi 1.3] */ readonly parentTableCell: Word.TableCell; /** - * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] */ readonly parentTableCellOrNullObject: Word.TableCell; /** - * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; /** - * Gets all of the table rows. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly rows: Word.TableRowCollection; + readonly shading: Word.ShadingUniversal; /** - * Gets the child tables nested one level deeper. + * Gets the collection of `Shape` objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. */ - readonly tables: Word.TableCollection; + readonly shapes: Word.ShapeCollection; /** - * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the number of header rows. + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - headerRowCount: number; + firstLineIndent: number; /** - * Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. + * Indicates the paragraph is the last one inside its parent body. * * @remarks * [Api set: WordApi 1.3] */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + readonly isLastParagraph: boolean; /** - * Indicates whether all of the table rows are uniform. + * Checks whether the paragraph is a list item. * * @remarks * [Api set: WordApi 1.3] */ - readonly isUniform: boolean; + readonly isListItem: boolean; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - readonly nestingLevel: number; + leftIndent: number; /** - * Gets the number of rows in the table. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - readonly rowCount: number; + lineSpacing: number; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - shadingColor: string; + lineUnitAfter: number; /** - * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - style: string; + lineUnitBefore: number; /** - * Specifies whether the table has banded columns. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - styleBandedColumns: boolean; + outlineLevel: number; /** - * Specifies whether the table has banded rows. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - styleBandedRows: boolean; + rightIndent: number; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + spaceAfter: number; /** - * Specifies whether the table has a first column with a special style. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - styleFirstColumn: boolean; + spaceBefore: number; /** - * Specifies whether the table has a last column with a special style. + * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - styleLastColumn: boolean; + style: string; /** - * Specifies whether the table has a total (last) row with a special style. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ - styleTotalRow: boolean; + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks * [Api set: WordApi 1.3] */ - values: string[][]; + readonly tableNestingLevel: number; /** - * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. + * Gets the text of the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + readonly text: string; /** - * Specifies the width of the table in points. + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - width: number; + readonly uniqueLocalId: string; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Table): void; + set(properties: Word.Paragraph): void; /** - * Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. + * Lets the paragraph join an existing list at the specified level. Fails if the paragraph cannot join the list or if the paragraph is already a list item. * * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation It must be `start` or `end`, corresponding to the appropriate side of the table. - * @param columnCount Number of columns to add. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * @param listId The ID of an existing list. + * @param level The level in the list. */ - addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void; + attachToList(listId: number, level: number): Word.List; /** - * Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows. + * Clears the contents of the `Paragraph` object. The user can perform the undo operation on the cleared content. * * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation It must be `start` or `end`. - * @param rowCount Number of rows to add. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * [Api set: WordApi 1.1] */ - addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; + clear(): void; /** - * Autofits the table columns to the width of the window. + * Removes any spacing before the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - autoFitWindow(): void; + closeUp(): void; /** - * Clears the contents of the table. + * Deletes the paragraph and its content from the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - clear(): void; + delete(): void; /** - * Deletes the entire table. + * Moves this paragraph out of its list, if the paragraph is a list item. * * @remarks * [Api set: WordApi 1.3] */ - delete(): void; + detachFromList(): void; /** - * Deletes specific columns. This is applicable to uniform tables. + * Gets annotations set on this `Paragraph` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] * - * @param columnIndex The first column to delete. - * @param columnCount Optional. The number of columns to delete. Default 1. + * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. */ - deleteColumns(columnIndex: number, columnCount?: number): void; + getAnnotations(): Word.AnnotationCollection; /** - * Deletes specific rows. + * Gets comments associated with the paragraph. * * @remarks - * [Api set: WordApi 1.3] - * - * @param rowIndex The first row to delete. - * @param rowCount Optional. The number of rows to delete. Default 1. + * [Api set: WordApi 1.4] */ - deleteRows(rowIndex: number, rowCount?: number): void; + getComments(): Word.CommentCollection; /** - * Distributes the column widths evenly. This is applicable to uniform tables. + * Gets the currently supported content controls in the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options Optional. Options that define which content controls are returned. */ - distributeColumns(): void; + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets the border style for the specified border. + * Gets an HTML representation of the `Paragraph` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. * * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation The border location. + * [Api set: WordApi 1.1] */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + getHtml(): OfficeExtension.ClientResult; /** - * Gets the border style for the specified border. + * Gets the next paragraph. Throws an `ItemNotFound` error if the paragraph is the last one. * * @remarks * [Api set: WordApi 1.3] - * - * @param borderLocation The border location. */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + getNext(): Word.Paragraph; /** - * Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell doesn't exist. + * Gets the next paragraph. If the paragraph is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] + */ + getNextOrNullObject(): Word.Paragraph; + /** + * Gets the Office Open XML (OOXML) representation of the `Paragraph` object. * - * @param rowIndex The index of the row. - * @param cellIndex The index of the cell in the row. + * @remarks + * [Api set: WordApi 1.1] */ - getCell(rowIndex: number, cellIndex: number): Word.TableCell; + getOoxml(): OfficeExtension.ClientResult; /** - * Gets the table cell at a specified row and column. If the specified table cell doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the previous paragraph. Throws an `ItemNotFound` error if the paragraph is the first one. * * @remarks * [Api set: WordApi 1.3] + */ + getPrevious(): Word.Paragraph; + /** + * Gets the previous paragraph. If the paragraph is the first one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * - * @param rowIndex The index of the row. - * @param cellIndex The index of the cell in the row. + * @remarks + * [Api set: WordApi 1.3] */ - getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell; + getPreviousOrNullObject(): Word.Paragraph; /** - * Gets cell padding in points. + * Gets the whole paragraph, or the starting or ending point of the paragraph, as a range. * * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `after`, or `content`. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; /** - * Gets cell padding in points. + * Gets reviewed text based on `ChangeTrackingVersion` selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** - * Gets the next table. Throws an `ItemNotFound` error if this table is the last one. + * Gets reviewed text based on `ChangeTrackingVersion` selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ - getNext(): Word.Table; + getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Gets the next table. If this table is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Returns the text of the paragraph. This excludes equations, graphics (e.g., images, videos, drawings), and special characters that mark various content (e.g., for content controls, fields, comments, footnotes, endnotes). + By default, hidden text and text marked as deleted are excluded. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] + * + * @param options Optional. Options that define whether the final result should include hidden text and text marked as deleted. */ - getNextOrNullObject(): Word.Table; + getText(options?: Word.GetTextOptions | { + IncludeHiddenText?: boolean; + IncludeTextMarkedAsDeleted?: boolean; + }): OfficeExtension.ClientResult; /** - * Gets the paragraph after the table. Throws an `ItemNotFound` error if there isn't a paragraph after the table. + * Gets the text ranges in the paragraph by using punctuation marks and other ending marks. * * @remarks * [Api set: WordApi 1.3] + * + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ - getParagraphAfter(): Word.Paragraph; + getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Gets the paragraph after the table. If there isn't a paragraph after the table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the collection of the `TrackedChange` objects in the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - getParagraphAfterOrNullObject(): Word.Paragraph; + getTrackedChanges(): Word.TrackedChangeCollection; /** - * Gets the paragraph before the table. Throws an `ItemNotFound` error if there isn't a paragraph before the table. + * Indents the paragraph by one level. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - getParagraphBefore(): Word.Paragraph; + indent(): void; /** - * Gets the paragraph before the table. If there isn't a paragraph before the table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Indents the paragraph by a specified number of characters. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param count The number of characters for the indent. */ - getParagraphBeforeOrNullObject(): Word.Paragraph; + indentCharacterWidth(count: number): void; /** - * Gets the range that contains this table, or the range at the start or end of the table. + * Indents the first line of the paragraph by the specified number of characters. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] * - * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, or `after`. + * @param count The number of characters for the first line indent. */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range; + indentFirstLineCharacterWidth(count: number): void; /** - * Inserts a content control on the table. + * Inserts annotations on this `Paragraph` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] + * + * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. + * + * @param annotations Annotations to set. + * @returns An array of the inserted annotations identifiers. */ - insertContentControl(): Word.ContentControl; + insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult; + /** + * Inserts a break at the specified location in the main document. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param breakType The break type to add to the document. + * @param insertLocation The value must be `before` or `after`. + */ + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + /** + * Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param insertShapeOptions Optional. The location and size of canvas. The default location and size is (0, 0, 300, 200). + */ + insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + /** + * Wraps the `Paragraph` object with a content control. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. + * `dropDownList` and `comboBox` support was added in WordApi 1.9. Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. + * + * @param contentControlType Optional. Content control type to insert. Must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. The default is `richText`. + */ + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl; + /** + * Inserts a document into the paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. + * + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. + */ + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param geometricShapeType The geometric type of the shape to insert. + * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). + */ + insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + /** + * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param geometricShapeType The geometric type of the shape to insert. + * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). + */ + insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + /** + * Inserts HTML into the paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param html The HTML to be inserted in the paragraph. + * @param insertLocation The value must be `replace`, `start`, or `end`. + */ + insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts a picture into the paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertLocation The value must be `replace`, `start`, or `end`. + */ + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; + /** + * Inserts OOXML into the paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param ooxml The OOXML to be inserted in the paragraph. + * @param insertLocation The value must be `replace`, `start`, or `end`. + */ + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** * Inserts a paragraph at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] * * @param paragraphText The paragraph text to be inserted. * @param insertLocation The value must be `before` or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + /** + * Inserts a floating picture in front of text with its anchor at the beginning of the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. + */ + insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** * Inserts a table with the specified number of rows and columns. * @@ -106070,186 +106570,225 @@ declare namespace Word { */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; /** - * Merges the cells bounded inclusively by a first and last cell. + * Inserts text into the paragraph at the specified location. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] * - * @param topRow The row of the first cell. - * @param firstCell The index of the first cell in its row. - * @param bottomRow The row of the last cell. - * @param lastCell The index of the last cell in its row. + * @param text Text to be inserted. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ - mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; + insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** - * Performs a search with the specified search options on the scope of the `Table` object. The search results are a collection of `Range` objects. + * Inserts a floating text box in front of text with its anchor at the beginning of the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] * - * @param searchText The search text. - * @param searchOptions Optional. Options for the search. + * @param text Optional. The text to insert into the text box. + * @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100). */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * Joins a list paragraph with the closest list above or below this paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + */ + joinList(): void; + /** + * Returns a `Paragraph` object that represents the next paragraph. * - * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param count Optional. The number of paragraphs to move forward. */ - select(selectionMode?: Word.SelectionMode): void; + next(count: number): Word.Paragraph; /** - * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * Toggles the spacing before the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + */ + openOrCloseUp(): void; + /** + * Sets spacing before the paragraph to 12 points. * - * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - select(selectionMode?: "Select" | "Start" | "End"): void; + openUp(): void; /** - * Sets cell padding in points. + * Removes one level of indent for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + */ + outdent(): void; + /** + * Applies the next heading level style (Heading 1 through Heading 8) to the paragraph. * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. - * @param cellPadding The cell padding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + outlineDemote(): void; /** - * Sets cell padding in points. + * Demotes the paragraph to body text by applying the Normal style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + */ + outlineDemoteToBody(): void; + /** + * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph. * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. - * @param cellPadding The cell padding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + outlinePromote(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns the previous paragraph as a `Paragraph` object. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param count Optional. The number of paragraphs to move backward. */ - load(options?: Word.Interfaces.TableLoadOptions): Word.Table; + previous(count: number): Word.Paragraph; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Removes manual paragraph formatting (formatting not applied using a style). * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.Table; + reset(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Resets the paragraph that uses custom list levels to the original level settings. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Table; + resetAdvanceTo(): void; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Performs a search with the specified search options on the scope of the `Paragraph` object. The search results are a collection of `Range` objects. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param searchText The search text. + * @param searchOptions Optional. Options for the search. */ - track(): Word.Table; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Selects and navigates the Word UI to the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ - untrack(): Word.Table; + select(selectionMode?: Word.SelectionMode): void; /** - * 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.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.TableData; - } - /** - * Represents the `TableStyle` object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - class TableStyle extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + * Selects and navigates the Word UI to the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Specifies the table's alignment against the page margin. + * Selects the number or bullet in a list. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + selectNumber(): void; /** - * Specifies whether lines in tables formatted with a style break across pages. + * Separates a list into two separate lists. For numbered lists, the new list restarts numbering at the starting number, usually 1. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - allowBreakAcrossPage: boolean; + separateList(): void; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Sets the paragraph to single spacing. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - bottomCellMargin: number; + space1(): void; /** - * Specifies the spacing (in points) between the cells in a table style. + * Sets the paragraph to 1.5-line spacing. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - cellSpacing: number; + space1Pt5(): void; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Sets the paragraph to double spacing. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - leftCellMargin: number; + space2(): void; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Splits the paragraph into child ranges by using delimiters. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] + * + * @param delimiters The delimiters as an array of strings. + * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is `false` which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ - rightCellMargin: number; + split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Starts a new list with this paragraph. Fails if the paragraph is already a list item. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - topCellMargin: number; + startNewList(): Word.List; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Sets a hanging indent to a specified number of tab stops. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param count The number of tab stops for the hanging indent. */ - set(properties: Interfaces.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableStyle): void; + tabHangingIndent(count: number): void; + /** + * Sets the left indent for the paragraph to a specified number of tab stops. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param count The number of tab stops for the left indent. + */ + tabIndent(count: number): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle; + load(options?: Word.Interfaces.ParagraphLoadOptions): Word.Paragraph; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.TableStyle; + load(propertyNames?: string | string[]): Word.Paragraph; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -106258,1218 +106797,1311 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TableStyle; + }): Word.Paragraph; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableStyle; + track(): Word.Paragraph; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableStyle; + untrack(): Word.Paragraph; /** * 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.TableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Paragraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TableStyleData; + toJSON(): Word.Interfaces.ParagraphData; } /** - * Contains the collection of the document's {@link Word.Table} objects. + * Contains a collection of {@link Word.Paragraph} objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - class TableCollection extends OfficeExtension.ClientObject { + class ParagraphCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.Table[]; + readonly items: Word.Paragraph[]; /** - * Gets the first table in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Returns a `Paragraph` object that represents a new, blank paragraph added to the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param range The range before which you want the new paragraph to be added. The new paragraph doesn't replace the range. */ - getFirst(): Word.Table; + add(range: Word.Range): Word.Paragraph; /** - * Gets the first table in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Removes any spacing before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - getFirstOrNullObject(): Word.Table; + closeUp(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Decreases the spacing before and after paragraphs in six-point increments. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.TableCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCollection; + decreaseSpacing(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the first paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TableCollection; + getFirst(): Word.Paragraph; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the first paragraph in this collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * @remarks + * [Api set: WordApi 1.3] */ - track(): Word.TableCollection; + getFirstOrNullObject(): Word.Paragraph; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets the last paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] */ - untrack(): Word.TableCollection; - /** - * 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.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.TableCollectionData; - } - /** - * Represents a table column in a Word document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class TableColumn extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + getLast(): Word.Paragraph; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * Gets the last paragraph in this collection. If the collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - readonly borders: Word.BorderUniversalCollection; + getLastOrNullObject(): Word.Paragraph; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Increases the spacing before and after paragraphs in six-point increments. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly shading: Word.ShadingUniversal; + increaseSpacing(): void; /** - * Returns the position of this column in a collection. + * Indents the paragraphs by one level. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly columnIndex: number; + indent(): void; /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Indents the paragraphs in the collection by the specified number of characters. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param count The number of characters by which the specified paragraphs are to be indented. */ - readonly isFirst: boolean; + indentCharacterWidth(count: number): void; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Indents the first line of the paragraphs in the collection by the specified number of characters. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param count The number of characters by which the first line of each specified paragraph is to be indented. */ - readonly isLast: boolean; + indentFirstLineCharacterWidth(count: number): void; /** - * Returns the nesting level of the column. + * Toggles spacing before paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly nestingLevel: number; + openOrCloseUp(): void; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Sets spacing before the specified paragraphs to 12 points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredWidth: number; + openUp(): void; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Removes one level of indent for the paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + outdent(): void; /** - * Specifies the width of the column, in points. + * Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - width: number; + outlineDemote(): void; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Demotes the specified paragraphs to body text by applying the Normal style. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableColumn): void; + outlineDemoteToBody(): void; /** - * Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells. + * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - autoFit(): void; + outlinePromote(): void; /** - * Deletes the column. + * Sets the specified paragraphs to single spacing. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - delete(): void; + space1(): void; /** - * Selects the table column. + * Sets the specified paragraphs to 1.5-line spacing. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - select(): void; + space1Pt5(): void; /** - * Sets the width of the column in a table. + * Sets the specified paragraphs to double spacing. * * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param columnWidth The width to set. - * @param rulerStyle The ruler style to apply. + * [Api set: WordApiDesktop 1.4] */ - setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; + space2(): void; /** - * Sets the width of the column in a table. + * Sets a hanging indent to the specified number of tab stops. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] * - * @param columnWidth The width to set. - * @param rulerStyle The ruler style to apply. + * @param count The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ - setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + tabHangingIndent(count: number): void; /** - * Sorts the table column. + * Sets the left indent for the specified paragraphs to the specified number of tab stops. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param count The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ - sort(): void; + tabIndent(count: number): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn; + load(options?: Word.Interfaces.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.TableColumn; + load(propertyNames?: string | string[]): Word.ParagraphCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TableColumn; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableColumn; + track(): Word.ParagraphCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableColumn; + untrack(): Word.ParagraphCollection; /** * 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.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableColumnData; + toJSON(): Word.Interfaces.ParagraphCollectionData; } /** - * Represents a collection of {@link Word.TableColumn} objects in a Word document. + * Represents a style of paragraph in a document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - class TableColumnCollection extends OfficeExtension.ClientObject { + class ParagraphFormat extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.TableColumn[]; /** - * Returns a `TableColumn` object that represents a column added to a table. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] + */ + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * - * @param beforeColumn Optional. The column before which the new column is added. - * @returns A new `TableColumn` object. + * @remarks + * [Api set: WordApi 1.5] */ - add(beforeColumn?: Word.TableColumn): Word.TableColumn; + firstLineIndent: number; /** - * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - autoFit(): void; + keepTogether: boolean; /** - * Deletes the specified columns. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - delete(): void; + keepWithNext: boolean; /** - * Adjusts the width of the specified columns so that they are equal. + * Specifies the left indent. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - distributeWidth(): void; + leftIndent: number; /** - * Selects the specified table columns. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - select(): void; + lineSpacing: number; /** - * Sets the width of columns in a table. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] + */ + lineUnitAfter: number; + /** + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * - * @param columnWidth The width to set. - * @param rulerStyle The ruler style to apply. + * @remarks + * [Api set: WordApi 1.5] */ - setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; + lineUnitBefore: number; /** - * Sets the width of columns in a table. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] + */ + mirrorIndents: boolean; + /** + * Specifies the outline level for the specified paragraphs. * - * @param columnWidth The width to set. - * @param rulerStyle The ruler style to apply. + * @remarks + * [Api set: WordApi 1.5] */ - setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + /** + * Specifies the right indent (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + rightIndent: number; + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceAfter: number; + /** + * Specifies the spacing (in points) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceBefore: number; + /** + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + widowControl: boolean; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ParagraphFormat): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.TableColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableColumnCollection; + load(options?: Word.Interfaces.ParagraphFormatLoadOptions): Word.ParagraphFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.TableColumnCollection; + load(propertyNames?: string | string[]): Word.ParagraphFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableColumnCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ParagraphFormat; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableColumnCollection; + track(): Word.ParagraphFormat; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableColumnCollection; + untrack(): Word.ParagraphFormat; /** * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TableColumnCollectionData; + toJSON(): Word.Interfaces.ParagraphFormatData; } /** - * Represents a row in a Word document. + * Represents a contiguous area in a document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - class TableRow extends OfficeExtension.ClientObject { + class Range extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets cells. + * Returns a `BookmarkCollection` object that represents all the bookmarks in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly cells: Word.TableCellCollection; + readonly bookmarks: Word.BookmarkCollection; /** - * Gets the collection of endnotes in the table row. + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly endnotes: Word.NoteItemCollection; + readonly borders: Word.BorderUniversalCollection; /** - * Gets the collection of `Field` objects in the table row. + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - readonly fields: Word.FieldCollection; + readonly conflicts: Word.ConflictCollection; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Gets the collection of `ContentControl` objects in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - readonly font: Word.Font; + readonly contentControls: Word.ContentControlCollection; /** - * Gets the collection of footnotes in the table row. + * Returns an `EditorCollection` object that represents all the users authorized to modify the range when the document is in protected (read-only) mode. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - readonly footnotes: Word.NoteItemCollection; + readonly editors: Word.EditorCollection; /** - * Gets parent table. + * Gets the collection of endnotes in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - readonly parentTable: Word.Table; + readonly endnotes: Word.NoteItemCollection; /** - * Gets the number of cells in the row. + * Gets the collection of `Field` objects in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - readonly cellCount: number; + readonly fields: Word.FieldCollection; /** - * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + readonly font: Word.Font; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. + * Gets the collection of footnotes in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - readonly isHeader: boolean; + readonly footnotes: Word.NoteItemCollection; /** - * Specifies the preferred height of the row in points. + * Gets a `FrameCollection` object that represents all the frames in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - preferredHeight: number; + readonly frames: Word.FrameCollection; /** - * Gets the index of the row in its parent table. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly rowIndex: number; + readonly hyperlinks: Word.HyperlinkCollection; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Gets the collection of `InlinePicture` objects in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.2] */ - shadingColor: string; + readonly inlinePictures: Word.InlinePictureCollection; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - values: string[][]; + readonly listFormat: Word.ListFormat; /** - * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. + * Gets the collection of `List` objects in the range. * * @remarks * [Api set: WordApi 1.3] */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + readonly lists: Word.ListCollection; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Gets the collection of pages in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableRow): void; + readonly pages: Word.PageCollection; /** - * Clears the contents of the row. + * Gets the collection of `Paragraph` objects in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. */ - clear(): void; + readonly paragraphs: Word.ParagraphCollection; /** - * Deletes the entire row. + * Gets the parent body of the range. * * @remarks * [Api set: WordApi 1.3] */ - delete(): void; + readonly parentBody: Word.Body; /** - * Gets the border style of the cells in the row. + * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation The border location. + * [Api set: WordApi 1.1] */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + readonly parentContentControl: Word.ContentControl; /** - * Gets the border style of the cells in the row. + * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] - * - * @param borderLocation The border location. */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Gets cell padding in points. + * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + readonly parentTable: Word.Table; /** - * Gets cell padding in points. + * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + readonly parentTableCell: Word.TableCell; /** - * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. + * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] */ - getNext(): Word.TableRow; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * Gets the next row. If this row is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] */ - getNextOrNullObject(): Word.TableRow; + readonly parentTableOrNullObject: Word.Table; /** - * Inserts a content control on the row. + * Gets the collection of revisions that represents the tracked changes in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - insertContentControl(): Word.ContentControl; + readonly revisions: Word.RevisionCollection; /** - * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. + * Gets the collection of sections in the range. * * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation Where the new rows should be inserted, relative to the current row. It must be `before` or `after`. - * @param rowCount Number of rows to add. - * @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. + * [Api set: WordApiDesktop 1.3] */ - insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + readonly sections: Word.SectionCollection; /** - * Merges the row into one cell. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - merge(): Word.TableCell; + readonly shading: Word.ShadingUniversal; /** - * Performs a search with the specified search options on the scope of the row. The search results are a collection of `Range` objects. + * Gets the collection of `Shape` objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] * - * @param searchText The search text. - * @param searchOptions Optional. Options for the search. + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + readonly shapes: Word.ShapeCollection; /** - * Selects the row and navigates the Word UI to it. + * Gets a `TableColumnCollection` object that represents all the table columns in the range. * * @remarks - * [Api set: WordApi 1.3] - * - * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + * [Api set: WordApiDesktop 1.3] */ - select(selectionMode?: Word.SelectionMode): void; + readonly tableColumns: Word.TableColumnCollection; /** - * Selects the row and navigates the Word UI to it. + * Gets the collection of `Table` objects in the range. * * @remarks * [Api set: WordApi 1.3] - * - * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ - select(selectionMode?: "Select" | "Start" | "End"): void; + readonly tables: Word.TableCollection; /** - * Sets cell padding in points. + * Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. - * @param cellPadding The cell padding. + * [Api set: WordApiDesktop 1.4] */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + readonly bold: boolean; /** - * Sets cell padding in points. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. - * @param cellPadding The cell padding. + * [Api set: WordApiDesktop 1.4] */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + readonly boldBidirectional: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.TableRowLoadOptions): Word.TableRow; + case: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the character width of the range. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.TableRow; + characterWidth: Word.CharacterWidth | "Half" | "Full"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies if the range contains combined characters. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TableRow; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.TableRow; + combineCharacters: boolean; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.TableRow; - /** - * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.TableRowData; - } - /** - * Contains the collection of the document's {@link Word.TableRow} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class TableRowCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.TableRow[]; + readonly disableCharacterSpaceGrid: boolean; /** - * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - getFirst(): Word.TableRow; + readonly emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Gets the first row in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - getFirstOrNullObject(): Word.TableRow; + end: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection; + fitTextWidth: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies if a grammar check has been run on the range or document. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.TableRowCollection; + grammarChecked: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the proofing status (spelling and grammar checking) of the range. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableRowCollection; + hasNoProofing: boolean; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the highlight color for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.TableRowCollection; + readonly highlightColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the formatting for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.TableRowCollection; - /** - * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.TableRowCollectionData; - } - /** - * Represents a table cell in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class TableCell extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + horizontalInVertical: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Gets the `Body` object of the cell. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks * [Api set: WordApi 1.3] */ - readonly body: Word.Body; + hyperlink: string; /** - * Gets the parent row of the cell. + * Specifies the ID for the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly parentRow: Word.TableRow; + id: string; /** - * Gets the parent table of the cell. + * Checks whether the range length is zero. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentTable: Word.Table; + readonly isEmpty: boolean; /** - * Gets the index of the cell in its row. + * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly cellIndex: number; + readonly isEndOfRowMark: boolean; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - columnWidth: number; + readonly isTextVisibleOnScreen: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. + * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + readonly italic: boolean; /** - * Gets the index of the cell's row in the table. + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly rowIndex: number; + readonly italicBidirectional: boolean; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - shadingColor: string; + kana: Word.Kana | "Katakana" | "Hiragana"; /** - * Specifies the text of the cell. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - value: string; + languageDetected: boolean; /** - * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the width of the cell in points. + * Specifies an East Asian language for the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - readonly width: number; + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies a language for the range that isn't classified as an East Asian language. + * + * @remarks + * [Api set: WordApiDesktop 1.3] */ - set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableCell): void; + languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Deletes the column containing this cell. This is applicable to uniform tables. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - deleteColumn(): void; + showAll: boolean; /** - * Deletes the row containing this cell. + * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - deleteRow(): void; + spellingChecked: boolean; /** - * Gets the border style for the specified border. + * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation The border location. + * [Api set: WordApiDesktop 1.4] */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + start: number; /** - * Gets the border style for the specified border. + * Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation The border location. + * [Api set: WordApiDesktop 1.4] */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + readonly storyLength: number; /** - * Gets cell padding in points. + * Gets the story type for the range. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * [Api set: WordApiDesktop 1.4] */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Gets cell padding in points. + * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * [Api set: WordApi 1.1] */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + style: string; /** - * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ - getNext(): Word.TableCell; + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Gets the next cell. If this cell is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the text of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - getNextOrNullObject(): Word.TableCell; + readonly text: string; /** - * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + */ + twoLinesInOne: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Range): void; + /** + * Clears the contents of the `Range` object. The user can perform the undo operation on the cleared content. * - * @param insertLocation It must be `before` or `after`. - * @param columnCount Number of columns to add. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * @remarks + * [Api set: WordApi 1.1] */ - insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; + clear(): void; /** - * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. + * Compares this range's location with another range's location. * * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation It must be `before` or `after`. - * @param rowCount Number of rows to add. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * @param range The range to compare with this range. */ - insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + compareLocationWith(range: Word.Range): OfficeExtension.ClientResult; /** - * Sets cell padding in points. + * Deletes the range and its content from the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + */ + delete(): void; + /** + * Analyzes the range text to determine the language that it's written in. * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. - * @param cellPadding The cell padding. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + detectLanguage(): OfficeExtension.ClientResult; /** - * Sets cell padding in points. + * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges don't have a union. * * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. - * @param cellPadding The cell padding. + * @param range Another range. */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + expandTo(range: Word.Range): Word.Range; /** - * Splits the cell into the specified number of rows and columns. + * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. If the two ranges don't have a union, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] * - * @param rowCount The number of rows to split into. Must be a divisor of the number of underlying rows. - * @param columnCount The number of columns to split into. + * @param range Another range. */ - split(rowCount: number, columnCount: number): void; + expandToOrNullObject(range: Word.Range): Word.Range; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the names all bookmarks in or overlapping the range. A bookmark is hidden if its name starts with the underscore character. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.4] + * + * @param includeHidden Optional. Indicates whether to include hidden bookmarks. Default is `false` which indicates that the hidden bookmarks are excluded. + * @param includeAdjacent Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is `false` which indicates that the adjacent bookmarks are excluded. */ - load(options?: Word.Interfaces.TableCellLoadOptions): Word.TableCell; + getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets comments associated with the range. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.4] + * @returns A `CommentCollection` object that contains all the comments associated with the range. */ - load(propertyNames?: string | string[]): Word.TableCell; + getComments(): Word.CommentCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the currently supported content controls in the range. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApi 1.5] + * + * **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options Optional. Options that define which content controls are returned. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TableCell; + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets an HTML representation of the `Range` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. + * + * @remarks + * [Api set: WordApi 1.1] */ - track(): Word.TableCell; + getHtml(): OfficeExtension.ClientResult; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets hyperlink child ranges within the range. + * + * @remarks + * [Api set: WordApi 1.3] */ - untrack(): Word.TableCell; - /** - * 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.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.TableCellData; - } - /** - * Contains the collection of the document's {@link Word.TableCell} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class TableCellCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.TableCell[]; + getHyperlinkRanges(): Word.RangeCollection; /** - * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the next text range by using punctuation marks and other ending marks. Throws an `ItemNotFound` error if this text range is the last one. * * @remarks * [Api set: WordApi 1.3] + * + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is `false` which indicates that spacing characters at the start and end of the range are included. */ - getFirst(): Word.TableCell; + getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range; /** - * Gets the first table cell in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the next text range by using punctuation marks and other ending marks. If this text range is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] + * + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is `false` which indicates that spacing characters at the start and end of the range are included. */ - getFirstOrNullObject(): Word.TableCell; + getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the OOXML representation of the `Range` object. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.1] */ - load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; + getOoxml(): OfficeExtension.ClientResult; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Clones the `Range` object, or gets the starting or ending point of the range as a new range. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] + * + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `after`, or `content`. */ - load(propertyNames?: string | string[]): Word.TableCellCollection; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets reviewed text based on ChangeTrackingVersion selection. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection; + getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets reviewed text based on ChangeTrackingVersion selection. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ - track(): Word.TableCellCollection; + getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets the text child ranges in the range by using punctuation marks and other ending marks. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ - untrack(): Word.TableCellCollection; + getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * 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.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.TableCellCollectionData; - } - /** - * Specifies the border style. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class TableBorder extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + * Gets the collection of the `TrackedChange` objects in the range. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getTrackedChanges(): Word.TrackedChangeCollection; /** - * Specifies the table border color. + * Highlights the range temporarily without changing document content. + To highlight the text permanently, set the range's `font.highlightColor`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.8] */ - color: string; + highlight(): void; /** - * Specifies the type of the table border. + * Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * Note: The conditions of inserting a bookmark are similar to doing so in the Word UI. To learn more about managing bookmarks in the Word UI, see {@link https://support.microsoft.com/office/f68d781f-0150-4583-a90e-a4009d99c2a0 | Add or delete bookmarks in a Word document or Outlook message}. + * + * @param name The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ - type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + insertBookmark(name: string): void; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Inserts a break at the specified location in the main document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * @param breakType The break type to add. + * @param insertLocation The value must be `before` or `after`. */ - width: number; + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Inserts a floating canvas in front of text with its anchor at the beginning of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param insertShapeOptions Optional. The location and size of the canvas. The default location and size is (0, 0, 300, 200). */ - set(properties: Interfaces.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableBorder): void; + insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Insert a comment on the range. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.4] + * + * @param commentText The comment text to be inserted. + * @returns The `Comment` object that was inserted. */ - load(options?: Word.Interfaces.TableBorderLoadOptions): Word.TableBorder; + insertComment(commentText: string): Word.Comment; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Wraps the `Range` object with a content control. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.1] + * + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. + * `dropDownList` and `comboBox` support was added in WordApi 1.9. Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. + * + * @param contentControlType Optional. Content control type to insert. Must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. The default is `richText`. */ - load(propertyNames?: string | string[]): Word.TableBorder; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Inserts an endnote. The endnote reference is placed after the range. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApi 1.5] + * + * @param insertText Optional. Text to be inserted into the endnote body. The default is "". */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TableBorder; + insertEndnote(insertText?: string): Word.NoteItem; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Inserts a field at the specified location. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * + * @param insertLocation The location relative to the range where the field will be inserted. The value must be `replace`, `start`, `end`, `before`, or `after`. + * @param fieldType Optional. Can be any `FieldType` value. The default value is `empty`. + * @param text Optional. Additional properties or options if needed for specified field type. + * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. */ - track(): Word.TableBorder; + insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Inserts a field at the specified location. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * + * @param insertLocation The location relative to the range where the field will be inserted. The value must be `replace`, `start`, `end`, `before`, or `after`. + * @param fieldType Optional. Can be any `FieldType` value. The default value is `empty`. + * @param text Optional. Additional properties or options if needed for specified field type. + * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. */ - untrack(): Word.TableBorder; + insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field; /** - * 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.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.TableBorderData; - } - /** - * Represents a document template. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class Template extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + * Inserts a document at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. + * + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. + */ + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. + * Inserts a footnote. The footnote reference is placed after the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] + * + * @param insertText Optional. Text to be inserted into the footnote body. The default is "". */ - readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; + insertFootnote(insertText?: string): Word.NoteItem; /** - * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. + * Inserts a geometric shape in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param geometricShapeType The geometric type of the shape to insert. + * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). */ - readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; + insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Inserts a geometric shape in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param geometricShapeType The geometric type of the shape to insert. + * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). */ - farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Specifies the line break control level for the document. + * Inserts HTML at the specified location. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] + * + * @param html The HTML to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ - farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Returns the name of the template, including the drive or Web path. + * Inserts a picture at the specified location. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.2] + * + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ - readonly fullName: string; + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Inserts OOXML at the specified location. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] + * + * @param ooxml The OOXML to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ - hasNoProofing: boolean; + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Specifies the character spacing adjustment for the template. + * Inserts a paragraph at the specified location. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] + * + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ - justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Inserts a floating picture in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. */ - kerningByAlgorithm: boolean; + insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Inserts a table with the specified number of rows and columns. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `before` or `after`. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; /** - * Specifies an East Asian language for the language in the template. + * Inserts text at the specified location. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] + * + * @param text Text to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Returns only the name of the document template (excluding any path or other location information). + * Inserts a floating text box in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param text Optional. The text to insert into the text box. + * @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100). */ - readonly name: string; + insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Returns a new range as the intersection of this range with another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges aren't overlapped or adjacent. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param range Another range. */ - noLineBreakAfter: string; + intersectWith(range: Word.Range): Word.Range; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Returns a new range as the intersection of this range with another range. This range isn't changed. If the two ranges aren't overlapped or adjacent, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param range Another range. */ - noLineBreakBefore: string; + intersectWithOrNullObject(range: Word.Range): Word.Range; /** - * Returns the path to the document template. + * Removes the highlight added by the `highlight` method if any. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.8] */ - readonly path: string; + removeHighlight(): void; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Performs a search with the specified search options on the scope of the `Range` object. The search results are a collection of `Range` objects. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] + * + * @param searchText The search text. + * @param searchOptions Optional. Options for the search. */ - saved: boolean; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Returns the template type. + * Selects and navigates the Word UI to the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] + * + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ - readonly type: Word.TemplateType | "Normal" | "Global" | "Attached"; + select(selectionMode?: Word.SelectionMode): void; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Selects and navigates the Word UI to the range. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ - set(properties: Interfaces.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Template): void; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Saves the template. + * Splits the range into child ranges by using delimiters. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param delimiters The delimiters as an array of strings. + * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is `false` which indicates that the paragraph boundaries are also used as delimiters. + * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is `false` which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ - save(): void; + split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.TemplateLoadOptions): Word.Template; + load(options?: Word.Interfaces.RangeLoadOptions): Word.Range; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Template; + load(propertyNames?: string | string[]): Word.Range; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -107478,586 +108110,593 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Template; + }): Word.Range; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Template; + track(): Word.Range; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Template; + untrack(): Word.Range; /** * 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.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Range` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TemplateData; + toJSON(): Word.Interfaces.RangeData; } /** - * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. - This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. - To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. + * Contains a collection of {@link Word.Range} objects. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - class TemplateCollection extends OfficeExtension.ClientObject { + class RangeCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.Template[]; - /** - * Returns the number of items in the collection. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - getCount(): OfficeExtension.ClientResult; + readonly items: Word.Range[]; /** - * Gets a `Template` object by its index in the collection. + * Gets the first range in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param index The index of the item to retrieve. + * [Api set: WordApi 1.3] */ - getItemAt(index: number): Word.Template; + getFirst(): Word.Range; /** - * Imports the building blocks for all templates into Microsoft Word. + * Gets the first range in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - importBuildingBlocks(): void; + getFirstOrNullObject(): Word.Range; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.TemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TemplateCollection; + load(options?: Word.Interfaces.RangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.TemplateCollection; + load(propertyNames?: string | string[]): Word.RangeCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TemplateCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RangeCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TemplateCollection; + track(): Word.RangeCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TemplateCollection; + untrack(): Word.RangeCollection; /** * 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.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TemplateCollectionData; + toJSON(): Word.Interfaces.RangeCollectionData; } /** - * Represents a tracked change in a Word document. + * Specifies the options to determine location and size when inserting a shape. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - class TrackedChange extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + interface InsertShapeOptions { /** - * Gets the author of the tracked change. + * If provided, specifies the height of the shape being inserted. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - readonly author: string; + height?: number; /** - * Gets the date of the tracked change. + * If provided, specifies the left position of the shape being inserted. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - readonly date: Date; + left?: number; /** - * Gets the text of the tracked change. + * If provided, specifies the top position of the shape being inserted. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - readonly text: string; + top?: number; /** - * Gets the type of the tracked change. + * If provided, specifies the width of the shape being inserted. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + width?: number; + } + /** + * Specifies the options to determine what to copy when inserting a file. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface InsertFileOptions { /** - * Accepts the tracked change. + * If provided, specifies whether the change tracking mode status from the source document should be imported. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - accept(): void; + importChangeTrackingMode?: boolean; /** - * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. + * If provided, specifies whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. * * @remarks * [Api set: WordApi 1.6] */ - getNext(): Word.TrackedChange; + importCustomProperties?: boolean; /** - * Gets the next tracked change. If this tracked change is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * If provided, specifies whether the custom XML parts from the source document should be imported. * * @remarks * [Api set: WordApi 1.6] */ - getNextOrNullObject(): Word.TrackedChange; + importCustomXmlParts?: boolean; /** - * Gets the range of the tracked change. + * If provided, specifies whether to import the Different Odd and Even Pages setting for the header and footer from the source document. * * @remarks - * [Api set: WordApi 1.6] - * - * @param rangeLocation Optional. Specifies the part of the tracked change to get the range for. If not specified, the whole range of the tracked change is returned. + * [Api set: WordApi 1.7] */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + importDifferentOddEvenPages?: boolean; /** - * Rejects the tracked change. + * If provided, specifies whether the page color and other background information from the source document should be imported. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - reject(): void; + importPageColor?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether the paragraph spacing from the source document should be imported. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.5] */ - load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange; + importParagraphSpacing?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether the styles from the source document should be imported. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.5] */ - load(propertyNames?: string | string[]): Word.TrackedChange; + importStyles?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether the theme from the source document should be imported. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TrackedChange; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TrackedChange; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * @remarks + * [Api set: WordApi 1.5] */ - untrack(): Word.TrackedChange; - /** - * 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.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.TrackedChangeData; + importTheme?: boolean; } /** - * Contains a collection of {@link Word.TrackedChange} objects. + * Specifies the options to be included in a search operation. + To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.1] */ - class TrackedChangeCollection extends OfficeExtension.ClientObject { + class SearchOptions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.TrackedChange[]; /** - * Accepts all the tracked changes in the collection. + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.1] */ - acceptAll(): void; + ignorePunct: boolean; /** - * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.1] */ - getFirst(): Word.TrackedChange; + ignoreSpace: boolean; /** - * Gets the first TrackedChange in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.1] */ - getFirstOrNullObject(): Word.TrackedChange; + matchCase: boolean; /** - * Rejects all the tracked changes in the collection. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.1] */ - rejectAll(): void; + matchPrefix: boolean; + /** + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchSuffix: boolean; + /** + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWholeWord: boolean; + /** + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWildcards: boolean; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.SearchOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.SearchOptions): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; + load(options?: Word.Interfaces.SearchOptionsLoadOptions): Word.SearchOptions; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.TrackedChangeCollection; + load(propertyNames?: string | string[]): Word.SearchOptions; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TrackedChangeCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TrackedChangeCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SearchOptions; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Create a new instance of the `Word.SearchOptions` object. */ - untrack(): Word.TrackedChangeCollection; + static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions; /** * 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.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.SearchOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SearchOptionsData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TrackedChangeCollectionData; + toJSON(): Word.Interfaces.SearchOptionsData; } /** - * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the options to be included in a {@link Word.Paragraph | Paragraph.getText} operation. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - class Shape extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + interface GetTextOptions { /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * If provided, specifies whether to include hidden text in the result of the `Paragraph.getText` method. The default value is `false`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - readonly body: Word.Body; + includeHiddenText?: boolean; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * If provided, specifies whether to include text marked as deleted in the result of the `Paragraph.getText` method. The default value is `false`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - readonly canvas: Word.Canvas; + includeTextMarkedAsDeleted?: boolean; + } + /** + * Specifies the options to be included in a compare document operation. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface DocumentCompareOptions { /** - * Returns the fill formatting of the shape. + * If provided, specifies whether to add the document to the list of recently used files on the **File** menu. The default value is `true`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - readonly fill: Word.ShapeFill; + addToRecentFiles?: boolean; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * If provided, specifies the reviewer name associated with the differences generated by the comparison. + If unspecified, the value defaults to the author name of the revised document or the string `Comparison` if no author information is present. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - readonly parentCanvas: Word.Shape; + authorName?: string; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * If provided, specifies the target document for the comparison. Default value is `compareTargetCurrent`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - readonly parentGroup: Word.Shape; + compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * If provided, specifies whether the comparison should include detection of format changes. The default value is `true`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - readonly shapeGroup: Word.ShapeGroup; + detectFormatChanges?: boolean; /** - * Gets the `TextFrame` object of the shape. + * If provided, specifies whether to compare the documents without notifying a user of problems. The default value is `false`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - readonly textFrame: Word.TextFrame; + ignoreAllComparisonWarnings?: boolean; /** - * Returns the text wrap formatting of the shape. + * If provided, specifies whether to remove date and time stamp information from tracked changes in the returned `Document` object. The default value is `false`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - readonly textWrap: Word.ShapeTextWrap; + removeDateAndTime?: boolean; /** - * Specifies whether a given shape can overlap other shapes. + * If provided, specifies whether to remove all user information from comments, revisions, and the properties dialog box in the returned `Document` object. The default value is `false`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - allowOverlap: boolean; + removePersonalInformation?: boolean; + } + /** + * Represents a section in a Word document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + class Section extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Specifies a string that represents the alternative text associated with the shape. + * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - altTextDescription: string; + readonly body: Word.Body; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + readonly borders: Word.BorderUniversalCollection; /** - * The height, in points, of the shape. + * Returns a `PageSetup` object that's associated with the section. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - height: number; + readonly pageSetup: Word.PageSetup; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies if the section is protected for forms. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - heightRelative: number; + protectedForForms: boolean; /** - * Gets an integer that represents the shape identifier. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - readonly id: number; + set(properties: Interfaces.SectionUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Section): void; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * Gets one of the section's footers. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] + * + * @param type The type of footer to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ - readonly isChild: boolean; + getFooter(type: Word.HeaderFooterType): Word.Body; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Gets one of the section's footers. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] + * + * @param type The type of footer to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ - left: number; + getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Gets one of the section's headers. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] + * + * @param type The type of header to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ - leftRelative: number; + getHeader(type: Word.HeaderFooterType): Word.Body; /** - * Specifies if the aspect ratio of this shape is locked. + * Gets one of the section's headers. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] + * + * @param type The type of header to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ - lockAspectRatio: boolean; + getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; /** - * The name of the shape. + * Gets the next section. Throws an `ItemNotFound` error if this section is the last one. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - name: string; + getNext(): Word.Section; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets the next section. If this section is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + getNextOrNullObject(): Word.Section; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param options Provides options for which properties of the object to load. */ - relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + load(options?: Word.Interfaces.SectionLoadOptions): Word.Section; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + load(propertyNames?: string | string[]): Word.Section; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Section; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - rotation: number; + track(): Word.Section; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - top: number; + untrack(): Word.Section; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * 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.Section` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SectionData; + } + /** + * Contains the collection of the document's {@link Word.Section} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + class SectionCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Section[]; + /** + * Gets the first section in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - topRelative: number; + getFirst(): Word.Section; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Gets the first section in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + getFirstOrNullObject(): Word.Section; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param options Provides options for which properties of the object to load. */ - visible: boolean; + load(options?: Word.Interfaces.SectionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SectionCollection; /** - * The width, in points, of the shape. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - width: number; + load(propertyNames?: string | string[]): Word.SectionCollection; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - widthRelative: number; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SectionCollection; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Shape): void; + track(): Word.SectionCollection; /** - * Deletes the shape and its content. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - delete(): void; + untrack(): Word.SectionCollection; /** - * Moves the shape horizontally by the number of points. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param distance Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. - */ - moveHorizontally(distance: number): void; - /** - * Moves the shape vertically by the number of points. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param distance Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. - */ - moveVertically(distance: number): void; - /** - * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. - */ - scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + * 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.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.SectionCollectionData; + } + /** + * Represents a setting of the add-in. + * + * @remarks + * [Api set: WordApi 1.4] + */ + class Setting extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Gets the key of the setting. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * [Api set: WordApi 1.4] */ - scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + readonly key: string; /** - * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * [Api set: WordApi 1.4] */ - scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + value: any; /** - * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + set(properties: Interfaces.SettingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Setting): void; /** - * Selects the shape. + * Deletes the setting. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is `false`. + * [Api set: WordApi 1.4] */ - select(selectMultipleShapes?: boolean): void; + delete(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape; + load(options?: Word.Interfaces.SettingLoadOptions): Word.Setting; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Shape; + load(propertyNames?: string | string[]): Word.Setting; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -108066,365 +108705,414 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Shape; + }): Word.Setting; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Shape; + track(): Word.Setting; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Shape; + untrack(): Word.Setting; /** * 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.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Setting` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ShapeData; + toJSON(): Word.Interfaces.SettingData; } /** - * Represents a shape group in the document. To get the corresponding {@link Word.Shape} object, use `ShapeGroup.shape`. + * Contains the collection of {@link Word.Setting} objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - class ShapeGroup extends OfficeExtension.ClientObject { + class SettingCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Setting[]; /** - * Gets the `Shape` object associated with the group. + * Creates a new setting or sets an existing setting. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] + * + * @param key The setting's key, which is case-sensitive. + * @param value The setting's value. */ - readonly shape: Word.Shape; + add(key: string, value: any): Word.Setting; /** - * Gets the collection of `Shape` objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Deletes all settings in this add-in. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - readonly shapes: Word.ShapeCollection; + deleteAll(): void; /** - * Gets an integer that represents the shape group identifier. + * Gets the number of items in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - readonly id: number; + getCount(): OfficeExtension.ClientResult; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Gets a `Setting` object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param key The key that identifies the `Setting` object. */ - set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeGroup): void; + getItem(key: string): Word.Setting; /** - * Ungroups any grouped shapes in the specified shape group. + * Gets a `Setting` object by its key, which is case-sensitive. If the setting doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] + * + * @param key The key that identifies the `Setting` object. */ - ungroup(): Word.ShapeCollection; + getItemOrNullObject(key: string): Word.Setting; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.ShapeGroupLoadOptions): Word.ShapeGroup; + load(options?: Word.Interfaces.SettingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SettingCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.ShapeGroup; + load(propertyNames?: string | string[]): Word.SettingCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShapeGroup; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SettingCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ShapeGroup; + track(): Word.SettingCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ShapeGroup; + untrack(): Word.SettingCollection; /** * 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.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.ShapeGroupData; + toJSON(): Word.Interfaces.SettingCollectionData; } /** - * Represents a canvas in the document. To get the corresponding {@link Word.Shape} object, use `Canvas.shape`. + * Contains a collection of {@link Word.Style} objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - class Canvas extends OfficeExtension.ClientObject { + class StyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Style[]; /** - * Gets the `Shape` object associated with the canvas. + * Get the `Style` object by its name. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] + * + * @param name The style name. */ - readonly shape: Word.Shape; + getByName(name: string): Word.Style; /** - * Gets the collection of {@link Word.Shape} objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] + * + * @param name The style name. */ - readonly shapes: Word.ShapeCollection; + getByNameOrNullObject(name: string): Word.Style; /** - * Gets an integer that represents the canvas identifier. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - readonly id: number; + getCount(): OfficeExtension.ClientResult; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Gets a `Style` object by its index in the collection. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param index The location of a `Style` object. */ - set(properties: Interfaces.CanvasUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Canvas): void; + getItem(index: number): Word.Style; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.CanvasLoadOptions): Word.Canvas; + load(options?: Word.Interfaces.StyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.StyleCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Canvas; + load(propertyNames?: string | string[]): Word.StyleCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Canvas; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.StyleCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Canvas; + track(): Word.StyleCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Canvas; + untrack(): Word.StyleCollection; /** * 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.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.CanvasData; + toJSON(): Word.Interfaces.StyleCollectionData; } /** - * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Represents a style in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - class ShapeCollection extends OfficeExtension.ClientObject { + class Style extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.Shape[]; /** - * Gets the shapes that have the specified geometric types. Only applied to geometric shapes. + * Specifies a `BorderCollection` object that represents all the borders for the style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] + */ + readonly borders: Word.BorderCollection; + /** + * Gets a `Font` object that represents the character formatting of the style. * - * @param types An array of geometric shape subtypes. + * @remarks + * [Api set: WordApi 1.5] */ - getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; + readonly font: Word.Font; /** - * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] + */ + readonly frame: Word.Frame; + /** + * Specifies a link between a paragraph and a character style. * - * @param id A shape identifier. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - getById(id: number): Word.Shape; + linkStyle: Word.Style; /** - * Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets a `ListTemplate` object that represents the list formatting for the style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] + */ + readonly listTemplate: Word.ListTemplate; + /** + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. * - * @param id A shape identifier. + * @remarks + * [Api set: WordApi 1.5] */ - getByIdOrNullObject(id: number): Word.Shape; + readonly paragraphFormat: Word.ParagraphFormat; /** - * Gets the shapes by the identifiers. + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] + */ + readonly shading: Word.Shading; + /** + * Gets a `TableStyle` object representing style properties that can be applied to a table. * - * @param ids An array of shape identifiers. + * @remarks + * [Api set: WordApi 1.6] */ - getByIds(ids: number[]): Word.ShapeCollection; + readonly tableStyle: Word.TableStyle; /** - * Gets the shapes that have the specified names. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] + */ + automaticallyUpdate: boolean; + /** + * Specifies the name of an existing style to use as the base formatting of another style. * - * @param names An array of shape names. + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - getByNames(names: string[]): Word.ShapeCollection; + baseStyle: string; /** - * Gets the shapes that have the specified types. + * Gets whether the style is a built-in style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] + */ + readonly builtIn: boolean; + /** + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * - * @param types An array of shape types. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; + hasProofing: boolean; /** - * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - getFirst(): Word.Shape; + readonly inUse: boolean; /** - * Gets the first shape in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - getFirstOrNullObject(): Word.Shape; + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Groups floating shapes in this collection, inline shapes will be skipped. Returns a `Shape` object that represents the new group of shapes. + * Specifies an East Asian language for the style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - group(): Word.Shape; + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether the style is a linked style that can be used for both paragraph and character formatting. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.5] */ - load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; + readonly linked: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns the list level for the style. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNames?: string | string[]): Word.ShapeCollection; + readonly listLevelNumber: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the style cannot be changed or edited. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ShapeCollection; + locked: boolean; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets the name of the style in the language of the user. + * + * @remarks + * [Api set: WordApi 1.5] */ - track(): Word.ShapeCollection; + readonly nameLocal: string; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - untrack(): Word.ShapeCollection; + nextParagraphStyle: string; /** - * 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.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.ShapeCollectionData; - } - /** - * Represents the fill formatting of a {@link Word.Shape} object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - class ShapeFill extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + noSpaceBetweenParagraphsOfSameStyle: boolean; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the priority. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - backgroundColor: string; + priority: number; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - foregroundColor: string; + quickStyle: boolean; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Gets the style type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - transparency: number; + readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + unhideWhenUsed: boolean; + /** + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * + * @remarks + * [Api set: WordApi 1.5] + */ + visibility: boolean; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeFill): void; + set(properties: Word.Style): void; /** - * Clears the fill formatting of this shape and sets it to `Word.ShapeFillType.noFill`. + * Deletes the style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - clear(): void; + delete(): void; /** - * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.solid`. + * Links this style to a list template so that the style's formatting can be applied to lists. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] * - * @param color A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * @param listTemplate A `ListTemplate` to link to the style. */ - setSolidColor(color: string): void; + linkToListTemplate(listTemplate: Word.ListTemplate): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill; + load(options?: Word.Interfaces.StyleLoadOptions): Word.Style; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.ShapeFill; + load(propertyNames?: string | string[]): Word.Style; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -108433,214 +109121,158 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.ShapeFill; + }): Word.Style; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ShapeFill; + track(): Word.Style; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ShapeFill; + untrack(): Word.Style; /** * 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.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Style` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ShapeFillData; + toJSON(): Word.Interfaces.StyleData; } /** - * Represents the text frame of a {@link Word.Shape} object. + * Represents the `Shading` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - class TextFrame extends OfficeExtension.ClientObject { + class Shading extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies the automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + backgroundPatternColor: string; /** - * Specifies the bottom margin, in points, of the text frame. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bottomMargin: number; + foregroundPatternColor: string; /** - * Returns `true` if the text frame contains text, otherwise, `false`. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - readonly hasText: boolean; + texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; /** - * Specifies the left margin, in points, of the text frame. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - leftMargin: number; + set(properties: Interfaces.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Shading): void; /** - * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param options Provides options for which properties of the object to load. */ - noTextRotation: boolean; + load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading; /** - * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + load(propertyNames?: string | string[]): Word.Shading; /** - * Specifies the right margin, in points, of the text frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - rightMargin: number; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Shading; /** - * Specifies the top margin, in points, of the text frame. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - topMargin: number; - /** - * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; - /** - * Determines whether lines break automatically to fit text inside the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - wordWrap: boolean; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TextFrame): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.TextFrame; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TextFrame; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TextFrame; + track(): Word.Shading; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TextFrame; + untrack(): Word.Shading; /** * 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.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Shading` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TextFrameData; + toJSON(): Word.Interfaces.ShadingData; } /** - * Represents all the properties for wrapping text around a {@link Word.Shape}. + * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - class ShapeTextWrap extends OfficeExtension.ClientObject { + class ShadingUniversal extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - bottomDistance: number; - /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - leftDistance: number; + backgroundPatternColor: string; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - rightDistance: number; + backgroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + foregroundPatternColor: string; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - topDistance: number; + foregroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ShadingUniversalUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeTextWrap): void; + set(properties: Word.ShadingUniversal): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap; + load(options?: Word.Interfaces.ShadingUniversalLoadOptions): Word.ShadingUniversal; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.ShapeTextWrap; + load(propertyNames?: string | string[]): Word.ShadingUniversal; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -108649,506 +109281,624 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.ShapeTextWrap; + }): Word.ShadingUniversal; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ShapeTextWrap; + track(): Word.ShadingUniversal; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ShapeTextWrap; + untrack(): Word.ShadingUniversal; /** * 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.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ShadingUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingUniversalData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ShapeTextWrapData; + toJSON(): Word.Interfaces.ShadingUniversalData; } /** - * Represents a single item in a {@link Word.RepeatingSectionContentControl}. + * Represents a table in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - class RepeatingSectionItem extends OfficeExtension.ClientObject { + class Table extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Returns the `TableColumnCollection` object that represents the columns in the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly range: Word.Range; + readonly columns: Word.TableColumnCollection; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Gets the collection of endnotes in the table. + * + * @remarks + * [Api set: WordApi 1.5] */ - set(properties: Interfaces.RepeatingSectionItemUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RepeatingSectionItem): void; + readonly endnotes: Word.NoteItemCollection; /** - * Deletes this `RepeatingSectionItem` object. + * Gets the collection of `Field` objects in the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - delete(): void; + readonly fields: Word.FieldCollection; /** - * Adds a repeating section item after this item and returns the new item. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - insertItemAfter(): Word.RepeatingSectionItem; + readonly font: Word.Font; /** - * Adds a repeating section item before this item and returns the new item. + * Gets the collection of footnotes in the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - insertItemBefore(): Word.RepeatingSectionItem; + readonly footnotes: Word.NoteItemCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the parent body of the table. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; + readonly parentBody: Word.Body; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.RepeatingSectionItem; + readonly parentContentControl: Word.ContentControl; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.RepeatingSectionItem; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] */ - track(): Word.RepeatingSectionItem; + readonly parentTable: Word.Table; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] */ - untrack(): Word.RepeatingSectionItem; - /** - * 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.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.RepeatingSectionItemData; - } - /** - * Represents a collection of {@link Word.RepeatingSectionItem} objects in a Word document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class RepeatingSectionItemCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + readonly parentTableCell: Word.TableCell; /** - * Returns an individual repeating section item. + * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + */ + readonly parentTableCellOrNullObject: Word.TableCell; + /** + * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * - * @param index The index of the item to retrieve. - * @returns A `RepeatingSectionItem` object representing the item at the specified index. + * @remarks + * [Api set: WordApi 1.3] */ - getItemAt(index: number): Word.RepeatingSectionItem; + readonly parentTableOrNullObject: Word.Table; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets all of the table rows. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.RepeatingSectionItemCollection; + readonly rows: Word.TableRowCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns the `ShadingUniversal` object that represents the shading of the table. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.RepeatingSectionItemCollection; + readonly shading: Word.ShadingUniversal; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Gets the child tables nested one level deeper. + * + * @remarks + * [Api set: WordApi 1.3] */ - track(): Word.RepeatingSectionItemCollection; + readonly tables: Word.TableCollection; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. + * + * @remarks + * [Api set: WordApi 1.3] */ - untrack(): Word.RepeatingSectionItemCollection; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * 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.RepeatingSectionItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): { - [key: string]: string; - }; - } - /** - * Represents the `DatePickerContentControl` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class DatePickerContentControl extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + * Specifies the description of the table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + description: string; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - readonly placeholderText: Word.BuildingBlock; + headerRowCount: number; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - readonly range: Word.Range; + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - readonly xmlMapping: Word.XmlMapping; + readonly isUniform: boolean; /** - * Specifies the appearance of the content control. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + readonly nestingLevel: number; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - color: string; + readonly rowCount: number; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + shadingColor: string; /** - * Specifies the format in which dates are displayed. + * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - dateDisplayFormat: string; + style: string; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + styleBandedColumns: boolean; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + styleBandedRows: boolean; /** - * Gets the identification for the content control. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - readonly id: string; + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - isTemporary: boolean; + styleFirstColumn: boolean; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + styleLastColumn: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - lockContentControl: boolean; + styleTotalRow: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the title of the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - lockContents: boolean; + title: string; /** - * Gets whether the placeholder text for the content control is being displayed. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - readonly showingPlaceholderText: boolean; + values: string[][]; /** - * Specifies a tag to identify the content control. + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - tag: string; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies the title for the content control. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - title: string; + width: number; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DatePickerContentControl): void; + set(properties: Word.Table): void; /** - * Copies the content control from the active document to the Clipboard. + * Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param insertLocation It must be `start` or `end`, corresponding to the appropriate side of the table. + * @param columnCount Number of columns to add. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - copy(): void; + addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param insertLocation It must be `start` or `end`. + * @param rowCount Number of rows to add. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - cut(): void; + addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Deletes this content control and the contents of the content control. + * Applies the specified style but maintains any formatting that a user directly applies. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] * - * @param deleteContents Optional. If `true`, deletes the contents as well. + * @param styleName The name of the style to apply. */ - delete(deleteContents?: boolean): void; + applyStyleDirectFormatting(styleName: string): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Determines how Microsoft Word resizes a table when the AutoFit feature is used. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] * - * @param options Optional. The options for configuring the content control's placeholder text. + * @param behavior How Word resizes the specified table with the AutoFit feature is used. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + autoFitBehavior(behavior: Word.AutoFitBehavior): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Determines how Microsoft Word resizes a table when the AutoFit feature is used. * - * @param options Provides options for which properties of the object to load. - */ - load(options?: Word.Interfaces.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * @remarks + * [Api set: WordApiDesktop 1.4] * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @param behavior How Word resizes the specified table with the AutoFit feature is used. */ - load(propertyNames?: string | string[]): Word.DatePickerContentControl; + autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Autofits the table columns to the width of the window. * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.DatePickerContentControl; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.DatePickerContentControl; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * @remarks + * [Api set: WordApi 1.3] */ - untrack(): Word.DatePickerContentControl; - /** - * 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.DatePickerContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DatePickerContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.DatePickerContentControlData; - } - /** - * Represents the `PictureContentControl` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class PictureContentControl extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + autoFitWindow(): void; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Applies a predefined look to a table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. An object that specifies the options for applying the table format. */ - readonly placeholderText: Word.BuildingBlock; + autoFormat(options?: Word.TableAutoFormatOptions): void; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Clears the contents of the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - readonly range: Word.Range; + clear(): void; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Converts a table to text. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. An object that specifies the options for converting the table to text. + * @returns A `Range` object that represents the converted text. */ - readonly xmlMapping: Word.XmlMapping; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Specifies the appearance of the content control. + * Deletes the entire table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + delete(): void; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Deletes specific columns. This is applicable to uniform tables. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param columnIndex The first column to delete. + * @param columnCount Optional. The number of columns to delete. Default 1. */ - color: string; + deleteColumns(columnIndex: number, columnCount?: number): void; /** - * Returns the identification for the content control. + * Deletes specific rows. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param rowIndex The first row to delete. + * @param rowCount Optional. The number of rows to delete. Default 1. */ - readonly id: string; + deleteRows(rowIndex: number, rowCount?: number): void; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Distributes the column widths evenly. This is applicable to uniform tables. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - isTemporary: boolean; + distributeColumns(): void; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param borderLocation The border location. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param borderLocation The border location. */ - lockContentControl: boolean; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell doesn't exist. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param rowIndex The index of the row. + * @param cellIndex The index of the cell in the row. */ - lockContents: boolean; + getCell(rowIndex: number, cellIndex: number): Word.TableCell; /** - * Returns whether the placeholder text for the content control is being displayed. + * Gets the table cell at a specified row and column. If the specified table cell doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param rowIndex The index of the row. + * @param cellIndex The index of the cell in the row. */ - readonly showingPlaceholderText: boolean; + getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell; /** - * Specifies a tag to identify the content control. + * Gets cell padding in points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ - tag: string; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * Specifies the title for the content control. + * Gets cell padding in points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ - title: string; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Gets the next table. Throws an `ItemNotFound` error if this table is the last one. + * + * @remarks + * [Api set: WordApi 1.3] */ - set(properties: Interfaces.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.PictureContentControl): void; + getNext(): Word.Table; /** - * Copies the content control from the active document to the Clipboard. + * Gets the next table. If this table is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - copy(): void; + getNextOrNullObject(): Word.Table; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Gets the paragraph after the table. Throws an `ItemNotFound` error if there isn't a paragraph after the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - cut(): void; + getParagraphAfter(): Word.Paragraph; /** - * Deletes the content control and optionally its contents. + * Gets the paragraph after the table. If there isn't a paragraph after the table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + */ + getParagraphAfterOrNullObject(): Word.Paragraph; + /** + * Gets the paragraph before the table. Throws an `ItemNotFound` error if there isn't a paragraph before the table. * - * @param deleteContents Optional. Decides whether to delete the contents of the content control. + * @remarks + * [Api set: WordApi 1.3] */ - delete(deleteContents?: boolean): void; + getParagraphBefore(): Word.Paragraph; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Gets the paragraph before the table. If there isn't a paragraph before the table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + */ + getParagraphBeforeOrNullObject(): Word.Paragraph; + /** + * Gets the range that contains this table, or the range at the start or end of the table. * - * @param options Optional. The options for configuring the content control's placeholder text. + * @remarks + * [Api set: WordApi 1.3] + * + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, or `after`. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range; + /** + * Inserts a content control on the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + insertContentControl(): Word.ContentControl; + /** + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `before` or `after`. + */ + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + /** + * Inserts a table with the specified number of rows and columns. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `before` or `after`. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + /** + * Merges the cells bounded inclusively by a first and last cell. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param topRow The row of the first cell. + * @param firstCell The index of the first cell in its row. + * @param bottomRow The row of the last cell. + * @param lastCell The index of the last cell in its row. + */ + mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; + /** + * Updates the table with the characteristics of the predefined table format set when the `autoFormat` method was called. The default predefined format is {@link Word.TableFormatType | TableFormatType.none}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + reapplyAutoFormat(): void; + /** + * Performs a search with the specified search options on the scope of the `Table` object. The search results are a collection of `Range` objects. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param searchText The search text. + * @param searchOptions Optional. Options for the search. + */ + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + /** + * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. + */ + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. + */ + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + /** + * Sorts the specified table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. An object that specifies the options for sorting the table. + */ + sort(options?: Word.TableSortOptions): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl; + load(options?: Word.Interfaces.TableLoadOptions): Word.Table; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.PictureContentControl; + load(propertyNames?: string | string[]): Word.Table; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -109157,180 +109907,166 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.PictureContentControl; + }): Word.Table; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.PictureContentControl; + track(): Word.Table; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.PictureContentControl; + untrack(): Word.Table; /** * 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.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.PictureContentControlData; + toJSON(): Word.Interfaces.TableData; } /** - * Represents the `GroupContentControl` object. + * Represents the `TableStyle` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - class GroupContentControl extends OfficeExtension.ClientObject { + class TableStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Returns a `BorderUniversalCollection` that represents all the borders for the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly placeholderText: Word.BuildingBlock; + readonly borders: Word.BorderUniversalCollection; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly range: Word.Range; + readonly shading: Word.Shading; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - readonly xmlMapping: Word.XmlMapping; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the appearance of the content control. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + allowBreakAcrossPage: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - color: string; + bottomCellMargin: number; /** - * Returns the identification for the content control. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - readonly id: string; + cellSpacing: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isTemporary: boolean; + columnStripe: number; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + isBreakAcrossPagesAllowed: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - lockContentControl: boolean; + leftCellMargin: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - lockContents: boolean; + leftIndent: number; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - readonly showingPlaceholderText: boolean; + rightCellMargin: number; /** - * Specifies a tag to identify the content control. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tag: string; + rowStripe: number; /** - * Specifies the title for the content control. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks - * [Api set: WordApiDesktop 1.3] - */ - title: string; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.GroupContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.GroupContentControl): void; + tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * Copies the content control from the active document to the Clipboard. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - copy(): void; + topCellMargin: number; /** - * Removes the content control from the active document and moves the content control to the Clipboard. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - cut(): void; + set(properties: Interfaces.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableStyle): void; /** - * Deletes the content control and optionally its contents. + * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] * - * @param deleteContents Optional. Whether to delete the contents inside the control. + * @param conditionCode The area of the table to which to apply the formatting. */ - delete(deleteContents: boolean): void; + condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. * * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param options Optional. The options for configuring the content control's placeholder text. - */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; - /** - * Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited. + * [Api set: WordApiDesktop 1.4] * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param conditionCode The area of the table to which to apply the formatting. */ - ungroup(): void; + condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.GroupContentControlLoadOptions): Word.GroupContentControl; + load(options?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.GroupContentControl; + load(propertyNames?: string | string[]): Word.TableStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -109339,405 +110075,412 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.GroupContentControl; + }): Word.TableStyle; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.GroupContentControl; + track(): Word.TableStyle; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.GroupContentControl; + untrack(): Word.TableStyle; /** * 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.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.GroupContentControlData; + toJSON(): Word.Interfaces.TableStyleData; } /** - * The options that define what placeholder to be used in the content control. + * Represents a tab stop in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - interface ContentControlPlaceholderOptions { + class TabStop extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * If provided, specifies the `BuildingBlock` object to use as placeholder. + * Gets the next tab stop in the collection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - buildingBlock?: Word.BuildingBlock; + readonly next: Word.TabStop; /** - * If provided, specifies the `Range` object to use as placeholder. + * Gets the previous tab stop in the collection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - range?: Word.Range; + readonly previous: Word.TabStop; /** - * If provided, specifies the text to use as placeholder. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - text?: string; - } - /** - * Represents the `BuildingBlockGalleryContentControl` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class BuildingBlockGalleryContentControl extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + readonly alignment: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets whether this tab stop is a custom tab stop. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly placeholderText: Word.BuildingBlock; + readonly customTab: boolean; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly range: Word.Range; + readonly leader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly xmlMapping: Word.XmlMapping; + readonly position: number; /** - * Specifies the appearance of the content control. + * Removes this custom tab stop. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + clear(): void; /** - * Specifies the category for the building block content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param options Provides options for which properties of the object to load. */ - buildingBlockCategory: string; + load(options?: Word.Interfaces.TabStopLoadOptions): Word.TabStop; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + load(propertyNames?: string | string[]): Word.TabStop; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - color: string; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TabStop; /** - * Gets the identification for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - readonly id: string; + track(): Word.TabStop; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TabStop; + /** + * 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.TabStop` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TabStopData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TabStopData; + } + /** + * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class TabStopCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.TabStop[]; + /** + * Returns a `TabStop` object that represents a custom tab stop added to the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param position The position of the tab stop. + * @param options Optional. The options to further configure the new tab stop. */ - isTemporary: boolean; + add(position: number, options?: Word.TabStopAddOptions): Word.TabStop; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Returns the next `TabStop` object to the right of the specified position. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param Position The position to check. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + after(Position: number): Word.TabStop; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Returns the next `TabStop` object to the left of the specified position. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param Position The position to check. */ - lockContentControl: boolean; + before(Position: number): Word.TabStop; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Clears all the custom tab stops from the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - lockContents: boolean; + clearAll(): void; /** - * Gets if the placeholder text for the content control is being displayed. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param options Provides options for which properties of the object to load. */ - readonly showingPlaceholderText: boolean; + load(options?: Word.Interfaces.TabStopCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TabStopCollection; /** - * Specifies a tag to identify the content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - tag: string; + load(propertyNames?: string | string[]): Word.TabStopCollection; /** - * Specifies the title for the content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - title: string; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TabStopCollection; /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - set(properties: Interfaces.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.BuildingBlockGalleryContentControl): void; + track(): Word.TabStopCollection; /** - * Copies the content control from the active document to the Clipboard. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TabStopCollection; + /** + * 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.TabStopCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TabStopCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TabStopCollectionData; + } + /** + * Specifies the options for adding to a {@link Word.TabStopCollection} object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TabStopAddOptions { + /** + * If provided, specifies the alignment of the tab stop. The default value is `left`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - copy(): void; + alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * If provided, specifies the leader character for the tab stop. The default value is `spaces`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - cut(): void; + leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** + * Contains the collection of the document's {@link Word.Table} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + class TableCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Table[]; /** - * Deletes the content control and optionally its contents. + * Gets the first table in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param deleteContents Optional. Whether to delete the contents inside the control. + * [Api set: WordApi 1.3] */ - delete(deleteContents?: boolean): void; + getFirst(): Word.Table; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Gets the first table in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param options Optional. The options for configuring the content control's placeholder text. + * [Api set: WordApi 1.3] */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + getFirstOrNullObject(): Word.Table; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl; + load(options?: Word.Interfaces.TableCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.BuildingBlockGalleryContentControl; + load(propertyNames?: string | string[]): Word.TableCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.BuildingBlockGalleryContentControl; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.BuildingBlockGalleryContentControl; + track(): Word.TableCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.BuildingBlockGalleryContentControl; + untrack(): Word.TableCollection; /** * 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.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; + toJSON(): Word.Interfaces.TableCollectionData; } /** - * Represents the `RepeatingSectionContentControl` object. + * Represents a table column in a Word document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - class RepeatingSectionContentControl extends OfficeExtension.ClientObject { + class TableColumn extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly placeholderText: Word.BuildingBlock; + readonly borders: Word.BorderUniversalCollection; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly range: Word.Range; + readonly shading: Word.ShadingUniversal; /** - * Returns the collection of repeating section items in this repeating section content control. + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly repeatingSectionItems: Word.RepeatingSectionItemCollection; + readonly columnIndex: number; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - allowInsertDeleteSection: boolean; - /** - * Specifies the appearance of the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; - /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ - color: string; + readonly isFirst: boolean; /** - * Returns the identification for the content control. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly id: string; + readonly isLast: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isTemporary: boolean; + readonly nestingLevel: number; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + preferredWidth: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContentControl: boolean; + preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContents: boolean; + width: number; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - repeatingSectionItemTitle: string; + set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableColumn): void; /** - * Returns whether the placeholder text for the content control is being displayed. + * Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells. * * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly showingPlaceholderText: boolean; + autoFit(): void; /** - * Specifies a tag to identify the content control. + * Deletes the column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - tag: string; + delete(): void; /** - * Specifies the title for the content control. + * Selects the table column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - title: string; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RepeatingSectionContentControl): void; + select(): void; /** - * Copies the content control from the active document to the Clipboard. + * Sets the width of the column in a table. * * @remarks * [Api set: WordApiDesktop 1.3] - */ - copy(): void; - /** - * Removes the content control from the active document and moves the content control to the Clipboard. * - * @remarks - * [Api set: WordApiDesktop 1.3] + * @param columnWidth The width to set. + * @param rulerStyle The ruler style to apply. */ - cut(): void; + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; /** - * Deletes the content control and the contents of the content control. + * Sets the width of the column in a table. * * @remarks * [Api set: WordApiDesktop 1.3] * - * @param deleteContents Optional. Whether to delete the contents inside the control. + * @param columnWidth The width to set. + * @param rulerStyle The ruler style to apply. */ - delete(deleteContents?: boolean): void; + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Sorts the table column. * * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param options Optional. The options for configuring the content control's placeholder text. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + sort(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl; + load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.RepeatingSectionContentControl; + load(propertyNames?: string | string[]): Word.TableColumn; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -109746,283 +110489,243 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.RepeatingSectionContentControl; + }): Word.TableColumn; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.RepeatingSectionContentControl; + track(): Word.TableColumn; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.RepeatingSectionContentControl; + untrack(): Word.TableColumn; /** * 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.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.RepeatingSectionContentControlData; + toJSON(): Word.Interfaces.TableColumnData; } /** - * Calendar types. + * Represents a collection of {@link Word.TableColumn} objects in a Word document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - enum CalendarType { - /** - * Western calendar type. - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - western = "Western", + class TableColumnCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.TableColumn[]; /** - * Arabic calendar type. + * Returns a `TableColumn` object that represents a column added to a table. + * * @remarks * [Api set: WordApiDesktop 1.3] + * + * @param beforeColumn Optional. The column before which the new column is added. + * @returns A new `TableColumn` object. */ - arabic = "Arabic", + add(beforeColumn?: Word.TableColumn): Word.TableColumn; /** - * Hebrew calendar type. + * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. + * * @remarks * [Api set: WordApiDesktop 1.3] */ - hebrew = "Hebrew", + autoFit(): void; /** - * Taiwan calendar type. + * Deletes the specified columns. + * * @remarks * [Api set: WordApiDesktop 1.3] */ - taiwan = "Taiwan", + delete(): void; /** - * Japanese calendar type. + * Adjusts the width of the specified columns so that they are equal. + * * @remarks * [Api set: WordApiDesktop 1.3] */ - japan = "Japan", + distributeWidth(): void; /** - * Thai calendar type. + * Selects the specified table columns. + * * @remarks * [Api set: WordApiDesktop 1.3] */ - thai = "Thai", + select(): void; /** - * Korean calendar type. + * Sets the width of columns in a table. + * * @remarks * [Api set: WordApiDesktop 1.3] + * + * @param columnWidth The width to set. + * @param rulerStyle The ruler style to apply. */ - korean = "Korean", + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; /** - * Saka Era calendar type. + * Sets the width of columns in a table. + * * @remarks * [Api set: WordApiDesktop 1.3] + * + * @param columnWidth The width to set. + * @param rulerStyle The ruler style to apply. */ - sakaEra = "SakaEra", + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Transliterated English calendar type. - * @remarks - * [Api set: WordApiDesktop 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - translitEnglish = "TranslitEnglish", + load(options?: Word.Interfaces.TableColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableColumnCollection; /** - * Transliterated French calendar type. - * @remarks - * [Api set: WordApiDesktop 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - translitFrench = "TranslitFrench", + load(propertyNames?: string | string[]): Word.TableColumnCollection; /** - * Umm al-Qura calendar type. - * @remarks - * [Api set: WordApiDesktop 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - umalqura = "Umalqura", - } - /** - * Date storage formats for {@link Word.DatePickerContentControl}. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum ContentControlDateStorageFormat { + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableColumnCollection; /** - * Stores the date as text. - * @remarks - * [Api set: WordApiDesktop 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - text = "Text", + track(): Word.TableColumnCollection; /** - * Stores the date as a date object. - * @remarks - * [Api set: WordApiDesktop 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - date = "Date", + untrack(): Word.TableColumnCollection; /** - * Stores the date as a date-time object. - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - dateTime = "DateTime", + * 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableColumnCollectionData; } /** - * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * Represents a table of authorities in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - class Frame extends OfficeExtension.ClientObject { + class TableOfAuthorities extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - readonly borders: Word.BorderUniversalCollection; - /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ readonly range: Word.Range; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - readonly shading: Word.ShadingUniversal; - /** - * Specifies the height (in points) of the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - height: number; - /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + bookmark: string; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - horizontalDistanceFromText: number; + category: number; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - horizontalPosition: number; + entrySeparator: string; /** - * Specifies if the frame is locked. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - lockAnchor: boolean; + isCategoryHeaderIncluded: boolean; /** - * Specifies the relative horizontal position of the frame. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + isEntryFormattingKept: boolean; /** - * Specifies the relative vertical position of the frame. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + isPassimUsed: boolean; /** - * Specifies if document text wraps around the frame. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textWrap: boolean; + pageNumberSeparator: string; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalDistanceFromText: number; + pageRangeSeparator: string; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalPosition: number; + sequenceName: string; /** - * Specifies the width (in points) of the frame. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - width: number; + sequenceSeparator: string; /** - * Specifies the rule used to determine the width of the frame. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** * 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. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Frame): void; - /** - * Copies the frame to the Clipboard. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - copy(): void; + set(properties: Word.TableOfAuthorities): void; /** - * Removes the frame from the document and places it on the Clipboard. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - cut(): void; - /** - * Deletes the frame. + * Deletes this table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ delete(): void; - /** - * Selects the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - select(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.FrameLoadOptions): Word.Frame; + load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.Frame; + load(propertyNames?: string | string[]): Word.TableOfAuthorities; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -110031,132 +110734,263 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Frame; + }): Word.TableOfAuthorities; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Frame; + track(): Word.TableOfAuthorities; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Frame; + untrack(): Word.TableOfAuthorities; /** * 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.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. + * 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.FrameData; + toJSON(): Word.Interfaces.TableOfAuthoritiesData; } /** - * Represents the collection of {@link Word.Frame} objects. + * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - class FrameCollection extends OfficeExtension.ClientObject { + class TableOfAuthoritiesCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.Frame[]; + readonly items: Word.TableOfAuthorities[]; /** - * Returns a `Frame` object that represents a new frame added to a range, selection, or document. + * Adds a table of authorities to the document at the specified range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] * - * @param range The range where the frame will be added. - * @returns A `Frame` object that represents the new frame. + * @param range The range where the table of authorities will appear. The table of authorities replaces the range if the range isn't collapsed. + * @param options Optional. The options to configure the table of authorities. */ - add(range: Word.Range): Word.Frame; + add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions): Word.TableOfAuthorities; /** - * Deletes the `FrameCollection` object. + * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} after all instances of the specified citation text. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param shortCitation The citation text to mark. + * @param options Optional. The options for marking the citation. */ - delete(): void; + markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): void; /** - * Gets a `Frame` object by its index in the collection. + * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} at the specified range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] * - * @param index The location of a `Frame` object. + * @param range The range where the citation will be inserted. + * @param shortCitation The short citation text. + * @param options Optional. The options for marking the citation. */ - getItem(index: number): Word.Frame; + markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): Word.Field; + /** + * Finds and selects the next instance of the specified citation text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param shortCitation The citation text to search for. + */ + selectNextCitation(shortCitation: string): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; + load(options?: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.FrameCollection; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FrameCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.FrameCollection; + track(): Word.TableOfAuthoritiesCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.FrameCollection; + untrack(): Word.TableOfAuthoritiesCollection; /** * 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.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.TableOfAuthoritiesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.FrameCollectionData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCollectionData; } /** - * Represents a document library version. + * Specifies the options for adding to a {@link Word.TableOfAuthoritiesCollection} object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - class DocumentLibraryVersion extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + interface TableOfAuthoritiesAddOptions { /** - * Gets any optional comments associated with this version of the shared document. + * 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 {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly comments: string; + bookmark?: string; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * If provided, specifies the category of entries to include in a table of authorities. + Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + The default value is `1`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly modified: any; + category?: number; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * 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 {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, no separator is used. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly modifiedBy: string; + entrySeparator?: string; + /** + * 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 {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + includeCategoryHeader?: boolean; + /** + * 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 {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + keepEntryFormatting?: boolean; + /** + * 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 {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, a comma and a space (", ") are used. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pageNumberSeparator?: string; + /** + * 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 {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, an en dash ("–") is used. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pageRangeSeparator?: string; + /** + * If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities. + Corresponds to the `\s` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sequenceName?: string; + /** + * 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 {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, a hyphen ("-") is used. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sequenceSeparator?: string; + /** + * 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 {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + usePassim?: boolean; + } + /** + * Specifies the options for inserting a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TableOfAuthoritiesMarkCitationOptions { + /** + * If provided, specifies the category number to be associated with the entry. + Values 1 through 16 correspond to the items listed in the Category dropdown list of the Mark Citation dialog. + The value `1` corresponds to the first category listed, `2` corresponds to the second category, and so on. + To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + category?: number; + /** + * If provided, specifies the long citation for the entry as it will appear in a table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + longCitation?: string; + /** + * If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + longCitationAutoText?: string; + } + /** + * Represents a category used in a table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class TableOfAuthoritiesCategory extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly name: string; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.DocumentLibraryVersionLoadOptions): Word.DocumentLibraryVersion; + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions): Word.TableOfAuthoritiesCategory; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.DocumentLibraryVersion; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategory; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -110165,17458 +110999,39880 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.DocumentLibraryVersion; + }): Word.TableOfAuthoritiesCategory; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.DocumentLibraryVersion; + track(): Word.TableOfAuthoritiesCategory; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.DocumentLibraryVersion; + untrack(): Word.TableOfAuthoritiesCategory; /** * 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.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableOfAuthoritiesCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DocumentLibraryVersionData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryData; } /** - * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - class DocumentLibraryVersionCollection extends OfficeExtension.ClientObject { + class TableOfAuthoritiesCategoryCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** Gets the loaded child items in this collection. */ - readonly items: Word.DocumentLibraryVersion[]; + readonly items: Word.TableOfAuthoritiesCategory[]; /** - * Gets a `DocumentLibraryVersion` object by its index in the collection. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param index The location of a `DocumentLibraryVersion` object. + * [Api set: WordApiDesktop 1.4] */ - getItem(index: number): Word.DocumentLibraryVersion; + getCount(): OfficeExtension.ClientResult; /** - * Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website. + * Returns a `TableOfAuthoritiesCategory` object that represents the specified item in the collection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param index The index of the item to retrieve. */ - isVersioningEnabled(): OfficeExtension.ClientResult; + getItemAt(index: number): Word.TableOfAuthoritiesCategory; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param options Provides options for which properties of the object to load. */ - load(options?: Word.Interfaces.DocumentLibraryVersionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.DocumentLibraryVersionCollection; + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCategoryCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - load(propertyNames?: string | string[]): Word.DocumentLibraryVersionCollection; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategoryCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.DocumentLibraryVersionCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCategoryCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.DocumentLibraryVersionCollection; + track(): Word.TableOfAuthoritiesCategoryCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.DocumentLibraryVersionCollection; + untrack(): Word.TableOfAuthoritiesCategoryCollection; /** * 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.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.TableOfAuthoritiesCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryCollectionData; } /** - * Represents the possible change tracking modes. + * Represents a table of contents in a Word document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - enum ChangeTrackingMode { + class TableOfContents extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * ChangeTracking is turned off. + * Gets the additional styles used for the table of contents. The default "Heading 1" - "Heading 9" styles aren't included in this collection. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - off = "Off", + readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** - * ChangeTracking is turned on for everyone. + * Gets the portion of a document that is this table of contents. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - trackAll = "TrackAll", + readonly range: Word.Range; /** - * Tracking is turned on for my changes only. + * Specifies whether built-in heading styles are used for the table of contents. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - trackMineOnly = "TrackMineOnly", - } - /** - * Specify the current version or the original version of the text. - * - * @remarks - * [Api set: WordApi 1.4] - */ - enum ChangeTrackingVersion { + areBuiltInHeadingStylesUsed: boolean; /** + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - original = "Original", + areFieldsUsed: boolean; /** + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - current = "Current", - } - /** - * Specify the track state when ChangeTracking is on. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum ChangeTrackingState { + areHyperlinksUsedOnWeb: boolean; /** + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - unknown = "Unknown", + arePageNumbersHiddenOnWeb: boolean; /** + * Specifies whether page numbers are included in the table of contents. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - normal = "Normal", + arePageNumbersIncluded: boolean; /** + * Specifies whether page numbers are aligned with the right margin in the table of contents. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - added = "Added", + arePageNumbersRightAligned: boolean; /** + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - deleted = "Deleted", - } - /** - * TrackedChange type. - * - * @remarks - * [Api set: WordApi 1.6] - */ - enum TrackedChangeType { + lowerHeadingLevel: number; /** - * No revision. + * Specifies the character between entries and their page numbers in the table of contents. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - none = "None", + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Add change. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - added = "Added", + tableId: string; /** - * Delete change. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - deleted = "Deleted", + upperHeadingLevel: number; /** - * Format change. - * @remarks - * [Api set: WordApi 1.6] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - formatted = "Formatted", - } - /** - * Note item type. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum NoteItemType { + set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfContents): void; /** - * Footnote type. + * Deletes this table of contents. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - footnote = "Footnote", + delete(): void; /** - * Endnote type. + * Updates the entire table of contents. + * * @remarks - * [Api set: WordApi 1.5] - */ - endnote = "Endnote", - } - /** - * Provides information about the type of a raised event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum EventType { + * [Api set: WordApiDesktop 1.4] /** - * ContentControlDeleted represents the event that the content control has been deleted. + * Updates only the page numbers for items in this table of contents. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - contentControlDeleted = "ContentControlDeleted", + updatePageNumbers(): void; /** - * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - contentControlSelectionChanged = "ContentControlSelectionChanged", + load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents; /** - * ContentControlDataChanged represents the event that the data in the content control have been changed. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - contentControlDataChanged = "ContentControlDataChanged", + load(propertyNames?: string | string[]): Word.TableOfContents; /** - * ContentControlAdded represents the event a content control has been added to the document. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - contentControlAdded = "ContentControlAdded", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfContents; /** - * Represents that a content control has been entered. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - contentControlEntered = "ContentControlEntered", + track(): Word.TableOfContents; /** - * Represents that a content control has been exited. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - contentControlExited = "ContentControlExited", + untrack(): Word.TableOfContents; /** - * Represents that one or more new paragraphs were added. - * @remarks - * [Api set: WordApi 1.6] - */ - paragraphAdded = "ParagraphAdded", + * 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.TableOfContents` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableOfContentsData; + } + /** + * Represents a collection of {@link Word.TableOfContents} objects in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class TableOfContentsCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.TableOfContents[]; /** - * Represents that one or more paragraphs were changed. + * Adds a table of contents to the document at the specified range. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] + * + * @param range The range where the table of contents will be added. The table of contents replaces the range if the range isn't collapsed. + * @param options Optional. The options for configuring the table of contents. */ - paragraphChanged = "ParagraphChanged", + add(range: Word.Range, options?: Word.TableOfContentsAddOptions): Word.TableOfContents; /** - * Represents that one or more paragraphs were deleted. + * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] + * + * @param range The range where the entry will be inserted. + * @param options Optional. The options for marking the table of contents entry. */ - paragraphDeleted = "ParagraphDeleted", + markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; /** - * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. - * @remarks - * [Api set: WordApi 1.7] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - annotationClicked = "AnnotationClicked", + load(options?: Word.Interfaces.TableOfContentsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfContentsCollection; /** - * Represents that an annotation was hovered over in the document. - * @remarks - * [Api set: WordApi 1.7] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - annotationHovered = "AnnotationHovered", + load(propertyNames?: string | string[]): Word.TableOfContentsCollection; /** - * Represents that one or more annotations were added in the document. - * @remarks - * [Api set: WordApi 1.7] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - annotationInserted = "AnnotationInserted", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfContentsCollection; /** - * Represents that one or more annotations were deleted from the document. - * @remarks - * [Api set: WordApi 1.7] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - annotationRemoved = "AnnotationRemoved", + track(): Word.TableOfContentsCollection; /** - * Represents an action in the annotation pop-up. - * @remarks - * [Api set: WordApi 1.8] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - annotationPopupAction = "AnnotationPopupAction", + untrack(): Word.TableOfContentsCollection; + /** + * 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.TableOfContentsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableOfContentsCollectionData; } /** - * An enum that specifies an event's source. It can be local or remote (through coauthoring). + * Specifies the options for adding to a {@link Word.TableOfContentsCollection} object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - enum EventSource { + interface TableOfContentsAddOptions { /** - * Local source. + * If provided, specifies the string names of additional styles to use for the table of contents. + Use {@link Word.HeadingStyleCollection | HeadingStyleCollection.add} to create new heading styles. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - local = "Local", + addedStyles?: string; /** - * Remote source. + * If provided, specifies whether the page numbers in a table of contents should be hidden when publishing to the web. + The default value is `true`. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - remote = "Remote", - } - /** - * Provides information about the content control that raised the `contentControlAdded` event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlAddedEventArgs { + hidePageNumbersOnWeb?: boolean; /** - * The event type. See `Word.EventType` for details. + * If provided, specifies whether to include page numbers in a table of contents. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + includePageNumbers?: boolean; /** - * Gets the content control IDs. + * If provided, specifies the ending heading level for a table of contents and must be a value from 1 to 9. Must be greater than `upperHeadingLevel`. + Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `9`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - ids: number[]; + lowerHeadingLevel?: number; /** - * The source of the event. It can be local or remote (through coauthoring). + * If provided, specifies whether page numbers in a table of contents are aligned with the right margin. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised the `contentControlDataChanged` event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlDataChangedEventArgs { + rightAlignPageNumbers?: boolean; /** - * The event type. See `Word.EventType` for details. + * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of contents. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of contents includes TC fields that use the table identifier T. + If this argument is omitted, TC fields aren't used. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + tableId?: string; /** - * Gets the content control IDs. + * If provided, specifies the starting heading level for a table of contents and must be a value from 1 to 9. Should be smaller than `lowerHeadingLevel`. + Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `1`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - ids: number[]; + upperHeadingLevel?: number; /** - * The source of the event. It can be local or remote (through coauthoring). + * If provided, specifies whether to use built-in heading styles to create a table of contents. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised the `contentControlDeleted` event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlDeletedEventArgs { + useBuiltInHeadingStyles?: boolean; /** - * The event type. See `Word.EventType` for details. + * If provided, specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are used to create a table of contents. + Use the {@link Word.TableOfContentsCollection | TableOfContentsCollection.markTocEntry} method to mark entries to be included in a table of contents. + The default value is `false`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + useFields?: boolean; /** - * Gets the content control IDs. + * If provided, specifies whether entries in a table of contents should be formatted as hyperlinks when the document is published to the web. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - ids: number[]; + useHyperlinksOnWeb?: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * If provided, specifies whether to use outline levels to create a table of contents. + The default value is `false`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - source: Word.EventSource | "Local" | "Remote"; + useOutlineLevels?: boolean; } /** - * Provides information about the content control that raised the `contentControlEntered` event. + * Specifies the options for inserting a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - interface ContentControlEnteredEventArgs { + interface TableOfContentsMarkEntryOptions { /** - * The event type. See `Word.EventType` for details. + * If provided, specifies the text that appears in a table of contents or table of figures. + To indicate a subentry, include the main entry text and the subentry text, separated by a colon (":") (e.g., "Introduction:The Product"). + When the `entryAutoText` property is set, this property is ignored. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + entry?: string; /** - * Gets the content control IDs. + * If provided, specifies the AutoText entry name that includes text for the table of figures, or table of contents. + When this property is used, the `entry` property is ignored. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - ids: number[]; + entryAutoText?: string; /** - * The source of the event. It can be local or remote (through coauthoring). + * If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - source: Word.EventSource | "Local" | "Remote"; + level?: number; + /** + * If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration"). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tableId?: string; } /** - * Provides information about the content control that raised the `contentControlExited` event. + * Represents a table of figures in a Word document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - interface ContentControlExitedEventArgs { + class TableOfFigures extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * The event type. See `Word.EventType` for details. + * Gets the additional styles used for the table of figures. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** - * Gets the content control IDs. + * Gets the portion of a document that is this table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - ids: number[]; + readonly range: Word.Range; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised the `contentControlSelectionChanged` event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlSelectionChangedEventArgs { + areBuiltInHeadingStylesUsed: boolean; /** - * The event type. See `Word.EventType` for details. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + areFieldsUsed: boolean; /** - * Gets the content control IDs. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - ids: number[]; + areHyperlinksUsedOnWeb: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the paragraphs that raised the `paragraphAdded` event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ParagraphAddedEventArgs { + arePageNumbersHiddenOnWeb: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - source: Word.EventSource | "Local" | "Remote"; + arePageNumbersIncluded: boolean; /** - * The event type. See `Word.EventType` for details. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + arePageNumbersRightAligned: boolean; /** - * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the `paragraphChanged` event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ParagraphChangedEventArgs { + captionLabel: string; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - source: Word.EventSource | "Local" | "Remote"; + isLabelIncluded: boolean; /** - * The event type. See `Word.EventType` for details. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + lowerHeadingLevel: number; /** - * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the `paragraphDeleted` event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ParagraphDeletedEventArgs { + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - source: Word.EventSource | "Local" | "Remote"; + tableId: string; /** - * The event type. See `Word.EventType` for details. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + upperHeadingLevel: number; /** - * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfFigures): void; + /** + * Deletes this table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - uniqueLocalIds: string[]; + delete(): void; + /** + * Updates the entire table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + /** + * Updates only the page numbers for items in this table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + updatePageNumbers(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.TableOfFiguresLoadOptions): Word.TableOfFigures; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.TableOfFigures; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfFigures; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableOfFigures; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableOfFigures; + /** + * 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.TableOfFigures` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableOfFiguresData; } /** - * Specifies supported content control types and subtypes. + * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - enum ContentControlType { + class TableOfFiguresCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.TableOfFigures[]; /** - * Unknown content control type. + * Adds a table of figures to the document at the specified range. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param range The range where the table of figures will be added. The table of figures replaces the range if the range isn't collapsed. + * @param options Optional. The options for configuring the table of figures. */ - unknown = "Unknown", + add(range: Word.Range, options?: Word.TableOfFiguresAddOptions): Word.TableOfFigures; /** - * Rich text content control subtype containing inline elements. + * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range for marking entries in a table of figures. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param range The range where the TC field will be inserted. + * @param options Optional. The options for marking the entry. */ - richTextInline = "RichTextInline", + markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; /** - * Rich text content control subtype containing paragraphs. - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - richTextParagraphs = "RichTextParagraphs", + load(options?: Word.Interfaces.TableOfFiguresCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfFiguresCollection; /** - * Rich text content control subtype containing a whole cell. - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - richTextTableCell = "RichTextTableCell", + load(propertyNames?: string | string[]): Word.TableOfFiguresCollection; /** - * Rich text content control subtype containing a whole row. - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - richTextTableRow = "RichTextTableRow", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfFiguresCollection; /** - * Rich text content control subtype containing a whole table. - * @remarks - * [Api set: WordApi 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - richTextTable = "RichTextTable", + track(): Word.TableOfFiguresCollection; /** - * Plain text content control subtype containing inline elements. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableOfFiguresCollection; + /** + * 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.TableOfFiguresCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableOfFiguresCollectionData; + } + /** + * Specifies the options for adding to a {@link Word.TableOfFiguresCollection} object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TableOfFiguresAddOptions { + /** + * If provided, specifies the string names of additional styles to use for the table of figures. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - plainTextInline = "PlainTextInline", + addedStyles?: string; /** - * Plain text content control subtype containing paragraphs. + * If provided, specifies the label that identifies the items to include in a table of figures. + Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is "Figure". + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - plainTextParagraph = "PlainTextParagraph", + captionLabel?: string; /** - * Picture content control (type and subtype). + * If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web. + The default value is `true`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - picture = "Picture", + hidePageNumbersOnWeb?: boolean; /** - * Building block gallery content control (type and subtype). + * If provided, specifies whether to include the caption label and caption number in a table of figures. + The default value is `true`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - buildingBlockGallery = "BuildingBlockGallery", + includeLabel?: boolean; /** - * Check box content control (type and subtype). + * If provided, specifies whether page numbers are included in a table of figures. + The default value is `true`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - checkBox = "CheckBox", + includePageNumbers?: boolean; /** - * Combo box content control (type and subtype). + * If provided, specifies the ending heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and greater than `upperHeadingLevel`. + Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `9`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - comboBox = "ComboBox", + lowerHeadingLevel?: number; /** - * Dropdown list content control (type and subtype). + * If provided, specifies whether to align page numbers with the right margin in a table of figures. + The default value is `true`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - dropDownList = "DropDownList", + rightAlignPageNumbers?: boolean; /** - * Date picker content control (type and subtype). + * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of figures. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - datePicker = "DatePicker", + tableId?: string; /** - * Repeating section content control (type and subtype). + * If provided, specifies the starting heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `1`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - repeatingSection = "RepeatingSection", + upperHeadingLevel?: number; /** - * Rich text content control type. + * If provided, specifies whether to use built-in heading styles to create a table of figures. + The default value is `false`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - richText = "RichText", + useBuiltInHeadingStyles?: boolean; /** - * Plain text content control type. + * If provided, specifies whether to use {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} to create a table of figures. + Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures. + The default value is `false`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - plainText = "PlainText", + useFields?: boolean; /** - * Group content control type. + * If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web. + The default value is `true`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - group = "Group", + useHyperlinksOnWeb?: boolean; } /** - * Represents the content control appearance. + * Represents a row in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - enum ContentControlAppearance { + class TableRow extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Represents a content control shown as a shaded rectangle or bounding box (with optional title). + * Gets cells. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - boundingBox = "BoundingBox", + readonly cells: Word.TableCellCollection; /** - * Represents a content control shown as start and end markers. + * Gets the collection of endnotes in the table row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - tags = "Tags", + readonly endnotes: Word.NoteItemCollection; /** - * Represents a content control that isn't shown. + * Gets the collection of `Field` objects in the table row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - hidden = "Hidden", - } - /** - * Represents the content control level type. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum ContentControlLevel { + readonly fields: Word.FieldCollection; /** - * Represents an inline content control. + * Gets the font. Use this to get and set font name, size, color, and other properties. + * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - inline = "Inline", + readonly font: Word.Font; /** - * Represents a paragraph-level content control. + * Gets the collection of footnotes in the table row. + * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - paragraph = "Paragraph", + readonly footnotes: Word.NoteItemCollection; /** - * Represents a row-level content control. + * Gets parent table. + * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - row = "Row", + readonly parentTable: Word.Table; /** - * Represents a cell-level content control. + * Returns the `Range` object that represents the table row. + * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - cell = "Cell", - } - /** - * Represents the supported styles for underline format. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum UnderlineType { + readonly range: Word.Range; /** + * Returns the `ShadingUniversal` object that represents the shading of the table row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - mixed = "Mixed", - /** - * No underline. - * @remarks - * [Api set: WordApi 1.1] - */ - none = "None", - /** - * Warning: hidden has been deprecated. - * @deprecated Hidden is no longer supported. - * @remarks - * [Api set: WordApi 1.1] - */ - hidden = "Hidden", + readonly shading: Word.ShadingUniversal; /** - * Warning: dotLine has been deprecated. - * @deprecated DotLine is no longer supported. + * Gets the number of cells in the row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - dotLine = "DotLine", + readonly cellCount: number; /** - * A single underline. This is the default value. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - single = "Single", + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Only underline individual words. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - word = "Word", + readonly isHeader: boolean; /** - * A double underline. + * Specifies the preferred height of the row in points. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - double = "Double", + preferredHeight: number; /** - * A single thick underline. + * Gets the index of the row in its parent table. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - thick = "Thick", + readonly rowIndex: number; /** - * A dotted underline. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - dotted = "Dotted", + shadingColor: string; /** - * A heavy dotted underline. + * Specifies the text values in the row, as a 2D JavaScript array. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - dottedHeavy = "DottedHeavy", + values: string[][]; /** - * A single dash underline. + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - dashLine = "DashLine", + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * A heavy dash underline. - * @remarks - * [Api set: WordApi 1.1] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - dashLineHeavy = "DashLineHeavy", + set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableRow): void; /** - * A long dash underline. + * Clears the contents of the row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - dashLineLong = "DashLineLong", + clear(): void; /** - * A long heavy dash underline. + * Converts the table row to text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. An object that specifies the options for converting the table row to text. */ - dashLineLongHeavy = "DashLineLongHeavy", + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * An alternating dot-dash underline. + * Deletes the entire row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - dotDashLine = "DotDashLine", + delete(): void; /** - * A heavy dot-dash underline. + * Gets the border style of the cells in the row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param borderLocation The border location. */ - dotDashLineHeavy = "DotDashLineHeavy", + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * An alternating dot-dot-dash underline. + * Gets the border style of the cells in the row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param borderLocation The border location. */ - twoDotDashLine = "TwoDotDashLine", + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * An alternating heavy dot-dot-dash underline. + * Gets cell padding in points. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ - twoDotDashLineHeavy = "TwoDotDashLineHeavy", + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * A single wavy underline. + * Gets cell padding in points. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ - wave = "Wave", + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * A heavy wavy underline. + * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - waveHeavy = "WaveHeavy", + getNext(): Word.TableRow; /** - * A double wavy underline. + * Gets the next row. If this row is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - waveDouble = "WaveDouble", - } - /** - * Specifies the form of a break. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum BreakType { + getNextOrNullObject(): Word.TableRow; /** - * Page break at the insertion point. + * Inserts a content control on the row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - page = "Page", + insertContentControl(): Word.ContentControl; /** - * Warning: next has been deprecated. Use sectionNext instead. - * @deprecated Use sectionNext instead. + * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param insertLocation Where the new rows should be inserted, relative to the current row. It must be `before` or `after`. + * @param rowCount Number of rows to add. + * @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. */ - next = "Next", + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Section break on next page. + * Merges the row into one cell. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - sectionNext = "SectionNext", + merge(): Word.TableCell; /** - * New section without a corresponding page break. + * Performs a search with the specified search options on the scope of the row. The search results are a collection of `Range` objects. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param searchText The search text. + * @param searchOptions Optional. Options for the search. */ - sectionContinuous = "SectionContinuous", + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. + * Selects the row and navigates the Word UI to it. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ - sectionEven = "SectionEven", + select(selectionMode?: Word.SelectionMode): void; /** - * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. + * Selects the row and navigates the Word UI to it. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ - sectionOdd = "SectionOdd", + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Line break. + * Sets cell padding in points. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ - line = "Line", - } - /** - * Represents the insertion location type. - * - * @remarks - * [Api set: WordApi 1.1] - * - * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. - * If the location is `before` or `after`, the new content will be outside of the modified object. - * If the location is `start` or `end`, the new content will be included as part of the modified object. - */ - enum InsertLocation { + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** - * Add content before the contents of the calling object. + * Sets cell padding in points. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ - before = "Before", + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** - * Add content after the contents of the calling object. + * Sets the height of the row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the table row. */ - after = "After", + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Prepend content to the contents of the calling object. + * Sets the height of the row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the table row. */ - start = "Start", + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Append content to the contents of the calling object. + * Sets the left indent for the table row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param leftIndent The distance (in points) between the current left edge of the table row and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - end = "End", + setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; /** - * Replace the contents of the current object. + * Sets the left indent for the table row. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param leftIndent The distance (in points) between the current left edge of the table row and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - replace = "Replace", - } - /** - * Represents the horizontal alignment of text. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum Alignment { + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Mixed horizontal alignment. - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - mixed = "Mixed", + load(options?: Word.Interfaces.TableRowLoadOptions): Word.TableRow; /** - * Unknown alignment. - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - unknown = "Unknown", + load(propertyNames?: string | string[]): Word.TableRow; /** - * Alignment to the left. - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - left = "Left", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableRow; /** - * Alignment to the center. - * @remarks - * [Api set: WordApi 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - centered = "Centered", + track(): Word.TableRow; /** - * Alignment to the right. - * @remarks - * [Api set: WordApi 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - right = "Right", + untrack(): Word.TableRow; /** - * Fully justified alignment. - * @remarks - * [Api set: WordApi 1.1] - */ - justified = "Justified", + * 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.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableRowData; } /** - * Represents the type of header or footer. + * Contains the collection of the document's {@link Word.TableRow} objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - enum HeaderFooterType { + class TableRowCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.TableRow[]; /** - * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. + * Converts rows in a table to text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. An object that specifies the options for converting the table rows to text. + * @returns A `Range` object that represents the converted text. */ - primary = "Primary", + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Returns the header or footer on the first page of a section. + * Deletes the table rows. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - firstPage = "FirstPage", + delete(): void; /** - * Returns all headers or footers on even-numbered pages of a section. + * Adjusts the height of the rows so that they're equal. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - evenPages = "EvenPages", - } - /** - * Represents the types of `Body` objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - enum BodyType { + distributeHeight(): void; /** - * Unknown body type. + * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. + * * @remarks * [Api set: WordApi 1.3] */ - unknown = "Unknown", + getFirst(): Word.TableRow; /** - * Main document body. + * Gets the first row in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks * [Api set: WordApi 1.3] */ - mainDoc = "MainDoc", + getFirstOrNullObject(): Word.TableRow; /** - * Section body. + * Selects the table rows. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - section = "Section", + select(): void; /** - * Header body. + * Sets the height of the cells in a table. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the specified rows. */ - header = "Header", + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Footer body. + * Sets the height of the cells in a table. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the specified rows. */ - footer = "Footer", + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Table cell body. + * Sets the left indent for the table row. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param leftIndent The distance (in points) between the current left edge of the specified rows and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - tableCell = "TableCell", + setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; /** - * Footnote body. + * Sets the left indent for the table row. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] + * + * @param leftIndent The distance (in points) between the current left edge of the specified rows and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - footnote = "Footnote", + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Endnote body. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - endnote = "Endnote", + load(options?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection; /** - * Note body e.g., endnote, footnote. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - noteItem = "NoteItem", - } - /** - * Represents where the cursor (insertion point) is set in the document after a selection. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum SelectionMode { + load(propertyNames?: string | string[]): Word.TableRowCollection; /** - * The entire range is selected. - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - select = "Select", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableRowCollection; /** - * The cursor is at the beginning of the selection (just before the start of the selected range). - * @remarks - * [Api set: WordApi 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - start = "Start", + track(): Word.TableRowCollection; /** - * The cursor is at the end of the selection (just after the end of the selected range). - * @remarks - * [Api set: WordApi 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - end = "End", + untrack(): Word.TableRowCollection; + /** + * 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.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableRowCollectionData; } /** - * Represents image format type. + * Represents a table cell in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - enum ImageFormat { + class TableCell extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Unsupported image format. + * Gets the `Body` object of the cell. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - unsupported = "Unsupported", + readonly body: Word.Body; /** - * Undefined image format. + * Returns the `TableColumn` object that represents the table column that contains this cell. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - undefined = "Undefined", + readonly column: Word.TableColumn; /** - * Bitmap image format. + * Gets the parent row of the cell. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - bmp = "Bmp", + readonly parentRow: Word.TableRow; /** - * JPEG image format. + * Gets the parent table of the cell. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - jpeg = "Jpeg", + readonly parentTable: Word.Table; /** - * GIF image format. + * Returns the `ShadingUniversal` object that represents the shading of the table cell. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - gif = "Gif", + readonly shading: Word.ShadingUniversal; /** - * TIFF image format. + * Gets the index of the cell in its row. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tiff = "Tiff", + readonly cellIndex: number; /** - * PNG image format. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - png = "Png", + columnWidth: number; /** - * Icon image format. + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - icon = "Icon", + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Exif image format. + * Gets the index of the cell's row in the table. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - exif = "Exif", + readonly rowIndex: number; /** - * Windows Metafile image format. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - wmf = "Wmf", + shadingColor: string; /** - * Enhanced Metafile image format. + * Specifies the text of the cell. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - emf = "Emf", + value: string; /** - * PICT image format. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - pict = "Pict", + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * PDF image format. + * Gets the width of the cell in points. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - pdf = "Pdf", + readonly width: number; /** - * SVG image format. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - svg = "Svg", - } - /** - * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - enum RangeLocation { + set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableCell): void; /** - * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that calculates and displays the sum of the values in table cells above or to the left of the cell specified in the expression. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - whole = "Whole", + autoSum(): void; /** - * The starting point of the object. For content control, it's the point after the opening tag. + * Deletes the table cell and optionally controls how the remaining cells are shifted. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - start = "Start", + delete(shiftCells: any): void; /** - * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. + * Deletes the column containing this cell. This is applicable to uniform tables. + * * @remarks * [Api set: WordApi 1.3] */ - end = "End", + deleteColumn(): void; /** - * For content control only. It's the point before the opening tag. + * Deletes the row containing this cell. + * * @remarks * [Api set: WordApi 1.3] */ - before = "Before", + deleteRow(): void; /** - * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that contains the specified formula into a table cell. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. An object that specifies the options for the formula. */ - after = "After", + formula(options?: Word.TableCellFormulaOptions): void; /** - * The range between `start` and `end`. + * Gets the border style for the specified border. + * * @remarks * [Api set: WordApi 1.3] + * + * @param borderLocation The border location. */ - content = "Content", - } - /** - * Represents the relationship of the location of this instance to another range. - * - * @remarks - * [Api set: WordApi 1.3] - */ - enum LocationRelation { + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * Indicates that this instance and the range are in different subdocuments. + * Gets the border style for the specified border. + * * @remarks * [Api set: WordApi 1.3] + * + * @param borderLocation The border location. */ - unrelated = "Unrelated", + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Indicates that this instance and the range represent the same range. + * Gets cell padding in points. + * * @remarks * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ - equal = "Equal", + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * Gets cell padding in points. + * * @remarks * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ - containsStart = "ContainsStart", + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. + * * @remarks * [Api set: WordApi 1.3] */ - containsEnd = "ContainsEnd", + getNext(): Word.TableCell; /** - * Indicates that this instance contains the range, with the exception of the start and end character of this instance. + * Gets the next cell. If this cell is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks * [Api set: WordApi 1.3] */ - contains = "Contains", + getNextOrNullObject(): Word.TableCell; /** - * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. + * * @remarks * [Api set: WordApi 1.3] + * + * @param insertLocation It must be `before` or `after`. + * @param columnCount Number of columns to add. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - insideStart = "InsideStart", + insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; /** - * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. + * * @remarks * [Api set: WordApi 1.3] + * + * @param insertLocation It must be `before` or `after`. + * @param rowCount Number of rows to add. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - insideEnd = "InsideEnd", + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. + * Merges this table cell with the specified table cell. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param mergeTo The cell to be merged with. */ - inside = "Inside", + merge(mergeTo: Word.TableCell): void; /** - * Indicates that this instance occurs before, and is adjacent to, the range. + * Selects the table cell. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - adjacentBefore = "AdjacentBefore", + select(): void; /** - * Indicates that this instance starts before the range and overlaps the range's first character. + * Sets cell padding in points. + * * @remarks * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ - overlapsBefore = "OverlapsBefore", + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** - * Indicates that this instance occurs before the range. + * Sets cell padding in points. + * * @remarks * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ - before = "Before", + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** - * Indicates that this instance occurs after, and is adjacent to, the range. + * Splits the cell into the specified number of rows and columns. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * @param rowCount The number of rows to split into. Must be a divisor of the number of underlying rows. + * @param columnCount The number of columns to split into. */ - adjacentAfter = "AdjacentAfter", + split(rowCount: number, columnCount: number): void; /** - * Indicates that this instance starts inside the range and overlaps the range’s last character. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - overlapsAfter = "OverlapsAfter", + load(options?: Word.Interfaces.TableCellLoadOptions): Word.TableCell; /** - * Indicates that this instance occurs after the range. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - after = "After", + load(propertyNames?: string | string[]): Word.TableCell; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableCell; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableCell; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableCell; + /** + * 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.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableCellData; } /** - * Represents the location of a {@link Word.Border | border}. + * Contains the collection of the document's {@link Word.TableCell} objects. * * @remarks * [Api set: WordApi 1.3] */ - enum BorderLocation { + class TableCellCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.TableCell[]; /** - * Top border. + * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - top = "Top", + autoFit(): void; /** - * Left border. + * Deletes the table cells and optionally controls how the remaining cells are shifted. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - left = "Left", + delete(shiftCells?: Word.DeleteCells): void; /** - * Bottom border. + * Deletes the table cells and optionally controls how the remaining cells are shifted. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - bottom = "Bottom", + delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void; /** - * Right border. + * Adjusts the height of the specified cells so that they are equal. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - right = "Right", + distributeHeight(): void; /** - * Inside horizontal border. + * Adjusts the width of the specified cells so that they are equal. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - insideHorizontal = "InsideHorizontal", + distributeWidth(): void; /** - * Inside vertical border. + * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. + * * @remarks * [Api set: WordApi 1.3] */ - insideVertical = "InsideVertical", + getFirst(): Word.TableCell; /** - * Inside border. + * Gets the first table cell in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks * [Api set: WordApi 1.3] */ - inside = "Inside", + getFirstOrNullObject(): Word.TableCell; /** - * Outside border. + * Merges the specified cells into a single cell. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - outside = "Outside", + merge(): void; /** - * All borders. + * Sets the height of the cells in a table. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param rowHeight The height of the row to set, in points. + * @param heightRule The rule for determining the height of the specified rows. */ - all = "All", - } - /** - * Represents the location of cell padding. - * - * @remarks - * [Api set: WordApi 1.3] - */ - enum CellPaddingLocation { + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Padding at the top of the cell. + * Sets the height of the cells in a table. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param rowHeight The height of the row to set, in points. + * @param heightRule The rule for determining the height of the specified rows. */ - top = "Top", + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Padding at the left of the cell. + * Sets the width of the cells in a table. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param columnWidth The width of the row to set, in points. + * @param rulerStyle The ruler style to apply. */ - left = "Left", + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; /** - * Padding at the bottom of the cell. + * Sets the width of the cells in a table. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param columnWidth The width of the row to set, in points. + * @param rulerStyle The ruler style to apply. */ - bottom = "Bottom", + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Padding at the right of the cell. + * Splits this range of table cells. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for splitting the table cells. */ - right = "Right", + split(options?: Word.TableCellCollectionSplitOptions): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.TableCellCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableCellCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TableCellCollection; + /** + * 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.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableCellCollectionData; } /** - * Represents the width of a style's border. + * Specifies the border style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - enum BorderWidth { - /** - * None width. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - none = "None", + class TableBorder extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * 0.25 point. + * Specifies the table border color. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - pt025 = "Pt025", + color: string; /** - * 0.50 point. + * Specifies the type of the table border. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - pt050 = "Pt050", + type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * 0.75 point. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - pt075 = "Pt075", + width: number; /** - * 1.00 point. This is the default. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - pt100 = "Pt100", + set(properties: Interfaces.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableBorder): void; /** - * 1.50 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - pt150 = "Pt150", + load(options?: Word.Interfaces.TableBorderLoadOptions): Word.TableBorder; /** - * 2.25 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - pt225 = "Pt225", + load(propertyNames?: string | string[]): Word.TableBorder; /** - * 3.00 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - pt300 = "Pt300", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableBorder; /** - * 4.50 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - pt450 = "Pt450", + track(): Word.TableBorder; /** - * 6.00 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - pt600 = "Pt600", + untrack(): Word.TableBorder; /** - * Mixed width. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - mixed = "Mixed", + * 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.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableBorderData; } /** - * The {@link Word.Border | border} types. + * Represents a document template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - enum BorderType { + class Template extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Mixed border type. + * Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - mixed = "Mixed", + readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; /** - * No border. + * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - none = "None", + readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; /** - * Single border. + * Returns a `ListTemplateCollection` object that represents all the list templates in the template. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - single = "Single", + readonly listTemplates: Word.ListTemplateCollection; /** - * Double border. + * Specifies the East Asian language to use when breaking lines of text in the document or template. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - double = "Double", + farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Dotted border. + * Specifies the line break control level for the document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - dotted = "Dotted", + farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Dashed border. + * Returns the name of the template, including the drive or Web path. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - dashed = "Dashed", + readonly fullName: string; /** - * Dot-dashed border. + * Specifies whether the spelling and grammar checker ignores documents based on this template. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - dotDashed = "DotDashed", + hasNoProofing: boolean; /** - * Double dot-dashed border. + * Specifies the character spacing adjustment for the template. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - dot2Dashed = "Dot2Dashed", + justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Triple border. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - triple = "Triple", + kerningByAlgorithm: boolean; /** - * Thin-thick small border. + * Specifies a `LanguageId` value that represents the language in the template. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - thinThickSmall = "ThinThickSmall", + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Thick-thin small border. + * Specifies an East Asian language for the language in the template. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - thickThinSmall = "ThickThinSmall", + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Thin-thick-thin small border. + * Returns only the name of the document template (excluding any path or other location information). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - thinThickThinSmall = "ThinThickThinSmall", + readonly name: string; /** - * Thin-thick medium border. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - thinThickMed = "ThinThickMed", + noLineBreakAfter: string; /** - * Thick-thin medium border. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - thickThinMed = "ThickThinMed", + noLineBreakBefore: string; /** - * Thin-thick-thin medium border. + * Returns the path to the document template. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - thinThickThinMed = "ThinThickThinMed", + readonly path: string; /** - * Thin-thick large border. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - thinThickLarge = "ThinThickLarge", + saved: boolean; /** - * Thick-thin large border. + * Returns the template type. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - thickThinLarge = "ThickThinLarge", + readonly type: Word.TemplateType | "Normal" | "Global" | "Attached"; /** - * Thin-thick-thin large border. - * @remarks - * [Api set: WordApi 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - thinThickThinLarge = "ThinThickThinLarge", + set(properties: Interfaces.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Template): void; /** - * Wave border. + * Saves the template. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - wave = "Wave", + save(): void; /** - * Double wave border. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - doubleWave = "DoubleWave", + load(options?: Word.Interfaces.TemplateLoadOptions): Word.Template; /** - * Dashed small border. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - dashedSmall = "DashedSmall", + load(propertyNames?: string | string[]): Word.Template; /** - * Dash-dot-stroked border. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - dashDotStroked = "DashDotStroked", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Template; /** - * 3D Emboss border. - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - threeDEmboss = "ThreeDEmboss", + track(): Word.Template; /** - * 3D Engrave border. - * @remarks - * [Api set: WordApi 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - threeDEngrave = "ThreeDEngrave", + untrack(): Word.Template; + /** + * 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.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TemplateData; } /** - * Represents the vertical alignment of text. + * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. + This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. + To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - enum VerticalAlignment { + class TemplateCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Template[]; /** - * Mixed vertical alignment. + * Returns the number of items in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - mixed = "Mixed", + getCount(): OfficeExtension.ClientResult; /** - * Top vertical alignment. + * Gets a `Template` object by its index in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] + * + * @param index The index of the item to retrieve. */ - top = "Top", + getItemAt(index: number): Word.Template; /** - * Center vertical alignment. + * Imports the building blocks for all templates into Microsoft Word. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - center = "Center", + importBuildingBlocks(): void; /** - * Bottom vertical alignment. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - bottom = "Bottom", + load(options?: Word.Interfaces.TemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TemplateCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.TemplateCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TemplateCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TemplateCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TemplateCollection; + /** + * 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.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TemplateCollectionData; } /** - * Represents the type of list level. + * Represents a tracked change in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - enum ListLevelType { + class TrackedChange extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Represents the bullet type. + * Gets the author of the tracked change. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - bullet = "Bullet", + readonly author: string; /** - * Represents the numbering type. + * Gets the date of the tracked change. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - number = "Number", + readonly date: Date; /** - * Represents the picture type. + * Gets the text of the tracked change. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - picture = "Picture", - } - /** - * Represents the bullet style in a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - enum ListBullet { + readonly text: string; /** - * Represents custom bullet. + * Gets the type of the tracked change. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - custom = "Custom", + readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; /** - * Represents solid bullet. + * Accepts the tracked change. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - solid = "Solid", + accept(): void; /** - * Represents hollow bullet. + * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - hollow = "Hollow", + getNext(): Word.TrackedChange; /** - * Represents square bullet. + * Gets the next tracked change. If this tracked change is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - square = "Square", + getNextOrNullObject(): Word.TrackedChange; /** - * Represents diamond bullet. + * Gets the range of the tracked change. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] + * + * @param rangeLocation Optional. Specifies the part of the tracked change to get the range for. If not specified, the whole range of the tracked change is returned. */ - diamonds = "Diamonds", + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** - * Represents arrow bullet. + * Rejects the tracked change. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - arrow = "Arrow", + reject(): void; /** - * Represents checkmark bullet. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - checkmark = "Checkmark", + load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.TrackedChange; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TrackedChange; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TrackedChange; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TrackedChange; + /** + * 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.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TrackedChangeData; } /** - * Represents the numbering style in a list. + * Contains a collection of {@link Word.TrackedChange} objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - enum ListNumbering { + class TrackedChangeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.TrackedChange[]; /** - * Represents no numbering. + * Accepts all the tracked changes in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - none = "None", + acceptAll(): void; /** - * Represents Arabic numbering. + * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - arabic = "Arabic", + getFirst(): Word.TrackedChange; /** - * Represents upper Roman numeral numbering. + * Gets the first TrackedChange in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - upperRoman = "UpperRoman", + getFirstOrNullObject(): Word.TrackedChange; /** - * Represents lower Roman numeral numbering. + * Rejects all the tracked changes in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - lowerRoman = "LowerRoman", + rejectAll(): void; /** - * Represents upper letter numbering. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - upperLetter = "UpperLetter", + load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; /** - * Represents lower letter numbering. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - lowerLetter = "LowerLetter", + load(propertyNames?: string | string[]): Word.TrackedChangeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TrackedChangeCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TrackedChangeCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TrackedChangeCollection; + /** + * 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.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TrackedChangeCollectionData; } /** - * Represents the built-in style in a Word document. + * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. * * @remarks - * [Api set: WordApi 1.3] - * - * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. + * [Api set: WordApiDesktop 1.4] */ - enum BuiltInStyleName { + class View extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Mixed styles or other style not in this list. + * Gets the instance of a `RevisionsFilter` object. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - other = "Other", + readonly revisionsFilter: Word.RevisionsFilter; /** - * Reset character and paragraph style to default. + * Specifies whether all nonprinting characters are displayed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - normal = "Normal", + areAllNonprintingCharactersDisplayed: boolean; /** - * Heading 1 style. + * Gets whether background colors and images are shown when the document is displayed in print layout view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - heading1 = "Heading1", + areBackgroundsDisplayed: boolean; /** - * Heading 2 style. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - heading2 = "Heading2", + readonly areBookmarksIndicated: boolean; /** - * Heading 3 style. + * Specifies whether Microsoft Word displays the comments in the document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - heading3 = "Heading3", + areCommentsDisplayed: boolean; /** - * Heading 4 style. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - heading4 = "Heading4", + areConnectingLinesToRevisionsBalloonDisplayed: boolean; /** - * Heading 5 style. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - heading5 = "Heading5", + readonly areCropMarksDisplayed: boolean; /** - * Heading 6 style. + * Gets whether objects created with the drawing tools are displayed in print layout view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - heading6 = "Heading6", + readonly areDrawingsDisplayed: boolean; /** - * Heading 7 style. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - heading7 = "Heading7", + areEditableRangesShaded: boolean; /** - * Heading 8 style. + * Specifies whether field codes are displayed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - heading8 = "Heading8", + areFieldCodesDisplayed: boolean; /** - * Heading 9 style. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - heading9 = "Heading9", + areFormatChangesDisplayed: boolean; /** - * Table-of-content level 1. + * Specifies whether handwritten ink annotations are shown or hidden. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - toc1 = "Toc1", + areInkAnnotationsDisplayed: boolean; /** - * Table-of-content level 2. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - toc2 = "Toc2", + areInsertionsAndDeletionsDisplayed: boolean; /** - * Table-of-content level 3. + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - toc3 = "Toc3", + readonly areLinesWrappedToWindow: boolean; /** - * Table-of-content level 4. + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - toc4 = "Toc4", + readonly areObjectAnchorsDisplayed: boolean; /** - * Table-of-content level 5. + * Gets whether Microsoft Word displays optional line breaks. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - toc5 = "Toc5", + readonly areOptionalBreaksDisplayed: boolean; /** - * Table-of-content level 6. + * Gets whether optional hyphens are displayed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - toc6 = "Toc6", + readonly areOptionalHyphensDisplayed: boolean; /** - * Table-of-content level 7. + * Gets whether other authors' presence should be visible in the document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - toc7 = "Toc7", + areOtherAuthorsVisible: boolean; /** - * Table-of-content level 8. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - toc8 = "Toc8", + readonly arePageBoundariesDisplayed: boolean; /** - * Table-of-content level 9. + * Gets whether paragraph marks are displayed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - toc9 = "Toc9", + readonly areParagraphsMarksDisplayed: boolean; /** - * Footnote text style. + * Gets whether blank boxes are displayed as placeholders for pictures. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - footnoteText = "FootnoteText", + readonly arePicturePlaceholdersDisplayed: boolean; /** - * Header style. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - header = "Header", + areRevisionsAndCommentsDisplayed: boolean; /** - * Footer style. + * Gets whether space characters are displayed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - footer = "Footer", + readonly areSpacesIndicated: boolean; /** - * Caption style. + * Specifies whether table gridlines are displayed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - caption = "Caption", + areTableGridlinesDisplayed: boolean; /** - * Footnote reference style. + * Gets whether tab characters are displayed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - footnoteReference = "FootnoteReference", + readonly areTabsDisplayed: boolean; /** - * Endnote reference style. + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - endnoteReference = "EndnoteReference", + readonly areTextBoundariesDisplayed: boolean; /** - * Endnote text style. + * Specifies the column width in Reading mode. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - endnoteText = "EndnoteText", + columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Title style. + * Gets on-screen shading for fields. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - title = "Title", + readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Subtitle style. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - subtitle = "Subtitle", + isDraft: boolean; /** - * Hyperlink style. + * Specifies whether only the first line of body text is shown in outline view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - hyperlink = "Hyperlink", + isFirstLineOnlyDisplayed: boolean; /** - * Strong style. + * Specifies whether character formatting is visible in outline view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - strong = "Strong", + isFormatDisplayed: boolean; /** - * Emphasis style. + * Specifies whether the window is in full-screen view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - emphasis = "Emphasis", + isFullScreen: boolean; /** - * No spacing style. + * Gets whether text formatted as hidden text is displayed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - noSpacing = "NoSpacing", + readonly isHiddenTextDisplayed: boolean; /** - * List paragraph style. + * Gets whether highlight formatting is displayed and printed with the document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - listParagraph = "ListParagraph", + readonly isHighlightingDisplayed: boolean; /** - * Quote style. + * Specifies whether the document is in conflict mode view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - quote = "Quote", + isInConflictMode: boolean; /** - * Intense quote style. + * Specifies whether Microsoft Word is in Panning mode. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - intenseQuote = "IntenseQuote", + isInPanning: boolean; /** - * Subtle emphasis style. + * Specifies whether the document is being viewed in reading layout view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - subtleEmphasis = "SubtleEmphasis", + isInReadingLayout: boolean; /** - * Intense emphasis style. + * Specifies whether mail merge data is displayed instead of mail merge fields. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - intenseEmphasis = "IntenseEmphasis", + isMailMergeDataView: boolean; /** - * Subtle reference style. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - subtleReference = "SubtleReference", + isMainTextLayerVisible: boolean; /** - * Intense reference style. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - intenseReference = "IntenseReference", + isPointerShownAsMagnifier: boolean; /** - * Book title style. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - bookTitle = "BookTitle", + isReadingLayoutActualView: boolean; /** - * Bibliography style. + * Specifies whether XML tags are visible in the document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - bibliography = "Bibliography", + isXmlMarkupVisible: boolean; /** - * Table-of-content heading. + * Specifies the display mode for tracked changes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - tocHeading = "TocHeading", + markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Table grid style. + * Specifies the page color in Reading mode. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - tableGrid = "TableGrid", + pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Plain table style 1. + * Specifies the page movement type. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - plainTable1 = "PlainTable1", + pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Plain table style 2. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - plainTable2 = "PlainTable2", + readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Plain table style 3. + * Gets whether Word displays revision balloons in the left or right margin in the document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - plainTable3 = "PlainTable3", + readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Plain table style 4. + * Specifies the width of the revision balloons. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - plainTable4 = "PlainTable4", + revisionsBalloonWidth: number; /** - * Plain table style 5. + * Specifies how Microsoft Word measures the width of revision balloons. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - plainTable5 = "PlainTable5", + revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Table grid light style. + * Specifies the document element displayed in print layout view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - tableGridLight = "TableGridLight", + seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Grid table light style 1. + * Specifies the active window pane. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - gridTable1Light = "GridTable1Light", + splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Grid table light style 1, accent 1. + * Specifies the view type. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - gridTable1Light_Accent1 = "GridTable1Light_Accent1", + type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; /** - * Grid table light style 1, accent 2. - * @remarks - * [Api set: WordApi 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - gridTable1Light_Accent2 = "GridTable1Light_Accent2", + set(properties: Interfaces.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.View): void; /** - * Grid table light style 1, accent 3. + * Collapses all the headings in the document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - gridTable1Light_Accent3 = "GridTable1Light_Accent3", + collapseAllHeadings(): void; /** - * Grid table light style 1, accent 4. + * Collapses the text under the selection or the specified range by one heading level. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param range A `Range` object that specifies the range to collapse. */ - gridTable1Light_Accent4 = "GridTable1Light_Accent4", + collapseOutline(range: Word.Range): void; /** - * Grid table light style 1, accent 5. + * Expands all the headings in the document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - gridTable1Light_Accent5 = "GridTable1Light_Accent5", + expandAllHeadings(): void; /** - * Grid table light style 1, accent 6. + * Expands the text under the selection by one heading level. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param range A `Range` object that specifies the range to expand. */ - gridTable1Light_Accent6 = "GridTable1Light_Accent6", + expandOutline(range: Word.Range): void; /** - * Grid table style 2. + * Moves to the next header or footer, depending on whether a header or footer is displayed in the view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - gridTable2 = "GridTable2", + nextHeaderFooter(): void; /** - * Grid table style 2, accent 1. + * Moves to the previous header or footer, depending on whether a header or footer is displayed in the view. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - gridTable2_Accent1 = "GridTable2_Accent1", + previousHeaderFooter(): void; /** - * Grid table style 2, accent 2. + * Switches between showing all text (headings and body text) and showing only headings. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - gridTable2_Accent2 = "GridTable2_Accent2", + showAllHeadings(): void; /** - * Grid table style 2, accent 3. + * Shows all headings up to the specified heading level and hides subordinate headings and body text. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] + * + * @param level The heading level to show. */ - gridTable2_Accent3 = "GridTable2_Accent3", + showHeading(level: number): void; /** - * Grid table style 2, accent 4. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - gridTable2_Accent4 = "GridTable2_Accent4", + load(options?: Word.Interfaces.ViewLoadOptions): Word.View; /** - * Grid table style 2, accent 5. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - gridTable2_Accent5 = "GridTable2_Accent5", + load(propertyNames?: string | string[]): Word.View; /** - * Grid table style 2, accent 6. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - gridTable2_Accent6 = "GridTable2_Accent6", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.View; /** - * Grid table style 3. - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - gridTable3 = "GridTable3", + track(): Word.View; /** - * Grid table style 3, accent 1. - * @remarks - * [Api set: WordApi 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - gridTable3_Accent1 = "GridTable3_Accent1", + untrack(): Word.View; /** - * Grid table style 3, accent 2. + * 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.View` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ViewData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ViewData; + } + /** + * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class Shape extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable3_Accent2 = "GridTable3_Accent2", + readonly body: Word.Body; /** - * Grid table style 3, accent 3. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable3_Accent3 = "GridTable3_Accent3", + readonly canvas: Word.Canvas; /** - * Grid table style 3, accent 4. + * Returns the fill formatting of the shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable3_Accent4 = "GridTable3_Accent4", + readonly fill: Word.ShapeFill; /** - * Grid table style 3, accent 5. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable3_Accent5 = "GridTable3_Accent5", + readonly parentCanvas: Word.Shape; /** - * Grid table style 3, accent 6. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable3_Accent6 = "GridTable3_Accent6", + readonly parentGroup: Word.Shape; /** - * Grid table style 4. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable4 = "GridTable4", + readonly shapeGroup: Word.ShapeGroup; /** - * Grid table style 4, accent 1. + * Gets the `TextFrame` object of the shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable4_Accent1 = "GridTable4_Accent1", + readonly textFrame: Word.TextFrame; /** - * Grid table style 4, accent 2. + * Returns the text wrap formatting of the shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable4_Accent2 = "GridTable4_Accent2", + readonly textWrap: Word.ShapeTextWrap; /** - * Grid table style 4, accent 3. + * Specifies whether a given shape can overlap other shapes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable4_Accent3 = "GridTable4_Accent3", + allowOverlap: boolean; /** - * Grid table style 4, accent 4. + * Specifies a string that represents the alternative text associated with the shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable4_Accent4 = "GridTable4_Accent4", + altTextDescription: string; /** - * Grid table style 4, accent 5. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable4_Accent5 = "GridTable4_Accent5", + geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; /** - * Grid table style 4, accent 6. + * The height, in points, of the shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable4_Accent6 = "GridTable4_Accent6", + height: number; /** - * Grid table dark style 5. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable5Dark = "GridTable5Dark", + heightRelative: number; /** - * Grid table dark style 5, accent 1. + * Gets an integer that represents the shape identifier. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", + readonly id: number; /** - * Grid table dark style 5, accent 2. + * Check whether this shape is a child of a group shape or a canvas shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", + readonly isChild: boolean; /** - * Grid table dark style 5, accent 3. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", + left: number; /** - * Grid table dark style 5, accent 4. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", + leftRelative: number; /** - * Grid table dark style 5, accent 5. + * Specifies if the aspect ratio of this shape is locked. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", + lockAspectRatio: boolean; /** - * Grid table dark style 5, accent 6. + * The name of the shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", + name: string; /** - * Grid table colorful style 6. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable6Colorful = "GridTable6Colorful", + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Grid table colorful style 6, accent 1. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", + relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Grid table colorful style 6, accent 2. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Grid table colorful style 6, accent 3. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", + relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Grid table colorful style 6, accent 4. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", + rotation: number; /** - * Grid table colorful style 6, accent 5. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", + top: number; /** - * Grid table colorful style 6, accent 6. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", + topRelative: number; /** - * Grid table colorful style 7. + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable7Colorful = "GridTable7Colorful", + readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * Grid table colorful style 7, accent 1. + * Specifies if the shape is visible. Not applicable to inline shapes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", + visible: boolean; /** - * Grid table colorful style 7, accent 2. + * The width, in points, of the shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", + width: number; /** - * Grid table colorful style 7, accent 3. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", + widthRelative: number; /** - * Grid table colorful style 7, accent 4. - * @remarks - * [Api set: WordApi 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", + set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Shape): void; /** - * Grid table colorful style 7, accent 5. + * Deletes the shape and its content. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", + delete(): void; /** - * Grid table colorful style 7, accent 6. + * Moves the shape horizontally by the number of points. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param distance Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. */ - gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", + moveHorizontally(distance: number): void; /** - * List table light style 1. + * Moves the shape vertically by the number of points. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param distance Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. */ - listTable1Light = "ListTable1Light", + moveVertically(distance: number): void; /** - * List table light style 1, accent 1. + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - listTable1Light_Accent1 = "ListTable1Light_Accent1", + scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; /** - * List table light style 1, accent 2. + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - listTable1Light_Accent2 = "ListTable1Light_Accent2", + scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; /** - * List table light style 1, accent 3. + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - listTable1Light_Accent3 = "ListTable1Light_Accent3", + scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; /** - * List table light style 1, accent 4. + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - listTable1Light_Accent4 = "ListTable1Light_Accent4", + scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; /** - * List table light style 1, accent 5. + * Selects the shape. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is `false`. */ - listTable1Light_Accent5 = "ListTable1Light_Accent5", + select(selectMultipleShapes?: boolean): void; /** - * List table light style 1, accent 6. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - listTable1Light_Accent6 = "ListTable1Light_Accent6", + load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape; /** - * List table style 2. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - listTable2 = "ListTable2", + load(propertyNames?: string | string[]): Word.Shape; /** - * List table style 2, accent 1. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - listTable2_Accent1 = "ListTable2_Accent1", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Shape; /** - * List table style 2, accent 2. - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - listTable2_Accent2 = "ListTable2_Accent2", + track(): Word.Shape; /** - * List table style 2, accent 3. - * @remarks - * [Api set: WordApi 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - listTable2_Accent3 = "ListTable2_Accent3", + untrack(): Word.Shape; /** - * List table style 2, accent 4. + * 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.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShapeData; + } + /** + * Represents a shape group in the document. To get the corresponding {@link Word.Shape} object, use `ShapeGroup.shape`. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class ShapeGroup extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the `Shape` object associated with the group. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable2_Accent4 = "ListTable2_Accent4", + readonly shape: Word.Shape; /** - * List table style 2, accent 5. + * Gets the collection of `Shape` objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable2_Accent5 = "ListTable2_Accent5", + readonly shapes: Word.ShapeCollection; /** - * List table style 2, accent 6. + * Gets an integer that represents the shape group identifier. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable2_Accent6 = "ListTable2_Accent6", + readonly id: number; /** - * List table style 3. - * @remarks - * [Api set: WordApi 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - listTable3 = "ListTable3", + set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeGroup): void; /** - * List table style 3, accent 1. + * Ungroups any grouped shapes in the specified shape group. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable3_Accent1 = "ListTable3_Accent1", + ungroup(): Word.ShapeCollection; /** - * List table style 3, accent 2. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - listTable3_Accent2 = "ListTable3_Accent2", + load(options?: Word.Interfaces.ShapeGroupLoadOptions): Word.ShapeGroup; /** - * List table style 3, accent 3. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - listTable3_Accent3 = "ListTable3_Accent3", + load(propertyNames?: string | string[]): Word.ShapeGroup; /** - * List table style 3, accent 4. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - listTable3_Accent4 = "ListTable3_Accent4", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShapeGroup; /** - * List table style 3, accent 5. - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - listTable3_Accent5 = "ListTable3_Accent5", + track(): Word.ShapeGroup; /** - * List table style 3, accent 6. - * @remarks - * [Api set: WordApi 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - listTable3_Accent6 = "ListTable3_Accent6", + untrack(): Word.ShapeGroup; /** - * List table style 4. - * @remarks - * [Api set: WordApi 1.3] - */ - listTable4 = "ListTable4", + * 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.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShapeGroupData; + } + /** + * Represents a canvas in the document. To get the corresponding {@link Word.Shape} object, use `Canvas.shape`. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class Canvas extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * List table style 4, accent 1. + * Gets the `Shape` object associated with the canvas. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable4_Accent1 = "ListTable4_Accent1", + readonly shape: Word.Shape; /** - * List table style 4, accent 2. + * Gets the collection of {@link Word.Shape} objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable4_Accent2 = "ListTable4_Accent2", + readonly shapes: Word.ShapeCollection; /** - * List table style 4, accent 3. + * Gets an integer that represents the canvas identifier. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable4_Accent3 = "ListTable4_Accent3", + readonly id: number; /** - * List table style 4, accent 4. - * @remarks - * [Api set: WordApi 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - listTable4_Accent4 = "ListTable4_Accent4", + set(properties: Interfaces.CanvasUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Canvas): void; /** - * List table style 4, accent 5. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - listTable4_Accent5 = "ListTable4_Accent5", + load(options?: Word.Interfaces.CanvasLoadOptions): Word.Canvas; /** - * List table style 4, accent 6. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - listTable4_Accent6 = "ListTable4_Accent6", + load(propertyNames?: string | string[]): Word.Canvas; /** - * List table dark style 5. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - listTable5Dark = "ListTable5Dark", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Canvas; /** - * List table dark style 5, accent 1. - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - listTable5Dark_Accent1 = "ListTable5Dark_Accent1", + track(): Word.Canvas; /** - * List table dark style 5, accent 2. - * @remarks - * [Api set: WordApi 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - listTable5Dark_Accent2 = "ListTable5Dark_Accent2", + untrack(): Word.Canvas; /** - * List table dark style 5, accent 3. + * 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.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CanvasData; + } + /** + * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class ShapeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Shape[]; + /** + * Gets the shapes that have the specified geometric types. Only applied to geometric shapes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param types An array of geometric shape subtypes. */ - listTable5Dark_Accent3 = "ListTable5Dark_Accent3", + getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; /** - * List table dark style 5, accent 4. + * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param id A shape identifier. */ - listTable5Dark_Accent4 = "ListTable5Dark_Accent4", + getById(id: number): Word.Shape; /** - * List table dark style 5, accent 5. + * Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param id A shape identifier. */ - listTable5Dark_Accent5 = "ListTable5Dark_Accent5", + getByIdOrNullObject(id: number): Word.Shape; /** - * List table dark style 5, accent 6. + * Gets the shapes by the identifiers. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param ids An array of shape identifiers. */ - listTable5Dark_Accent6 = "ListTable5Dark_Accent6", + getByIds(ids: number[]): Word.ShapeCollection; /** - * List table colorful style 6. + * Gets the shapes that have the specified names. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param names An array of shape names. */ - listTable6Colorful = "ListTable6Colorful", + getByNames(names: string[]): Word.ShapeCollection; /** - * List table colorful style 6, accent 1. + * Gets the shapes that have the specified types. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param types An array of shape types. */ - listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", + getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; /** - * List table colorful style 6, accent 2. + * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", + getFirst(): Word.Shape; /** - * List table colorful style 6, accent 3. + * Gets the first shape in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", + getFirstOrNullObject(): Word.Shape; /** - * List table colorful style 6, accent 4. + * Groups floating shapes in this collection, inline shapes will be skipped. Returns a `Shape` object that represents the new group of shapes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", + group(): Word.Shape; /** - * List table colorful style 6, accent 5. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", + load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; /** - * List table colorful style 6, accent 6. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", + load(propertyNames?: string | string[]): Word.ShapeCollection; /** - * List table colorful style 7. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - listTable7Colorful = "ListTable7Colorful", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ShapeCollection; /** - * List table colorful style 7, accent 1. - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", + track(): Word.ShapeCollection; /** - * List table colorful style 7, accent 2. - * @remarks - * [Api set: WordApi 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", + untrack(): Word.ShapeCollection; /** - * List table colorful style 7, accent 3. + * 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.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ShapeCollectionData; + } + /** + * Represents the fill formatting of a {@link Word.Shape} object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class ShapeFill extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", + backgroundColor: string; /** - * List table colorful style 7, accent 4. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", + foregroundColor: string; /** - * List table colorful style 7, accent 5. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", + transparency: number; /** - * List table colorful style 7, accent 6. + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", - } - /** - * Represents the document property type. - * - * @remarks - * [Api set: WordApi 1.3] - */ - enum DocumentPropertyType { + readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; /** - * Represents a string type. - * @remarks - * [Api set: WordApi 1.3] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - string = "String", + set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeFill): void; /** - * Represents a number type. + * Clears the fill formatting of this shape and sets it to `Word.ShapeFillType.noFill`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - number = "Number", + clear(): void; /** - * Represents a date type. + * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.solid`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param color A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. */ - date = "Date", + setSolidColor(color: string): void; /** - * Represents a Boolean type. - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - boolean = "Boolean", - } - /** - * Represents the type of style. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum StyleType { + load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill; /** - * Represents that the style is a character style. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - character = "Character", + load(propertyNames?: string | string[]): Word.ShapeFill; /** - * Represents that the style is a list style. Currently supported on desktop. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - list = "List", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShapeFill; /** - * Represents that the style is a paragraph style. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - paragraph = "Paragraph", + track(): Word.ShapeFill; /** - * Represents that the style is a table style. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - table = "Table", + untrack(): Word.ShapeFill; + /** + * 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.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShapeFillData; } /** - * Represents the outline levels. + * Represents the text frame of a {@link Word.Shape} object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - enum OutlineLevel { + class TextFrame extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Represents outline level 1. + * Specifies the automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel1 = "OutlineLevel1", + autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Represents outline level 2. + * Specifies the bottom margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel2 = "OutlineLevel2", + bottomMargin: number; /** - * Represents outline level 3. + * Returns `true` if the text frame contains text, otherwise, `false`. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel3 = "OutlineLevel3", + readonly hasText: boolean; /** - * Represents outline level 4. + * Specifies the left margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel4 = "OutlineLevel4", + leftMargin: number; /** - * Represents outline level 5. + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel5 = "OutlineLevel5", + noTextRotation: boolean; /** - * Represents outline level 6. + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel6 = "OutlineLevel6", + orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Represents outline level 7. + * Specifies the right margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel7 = "OutlineLevel7", + rightMargin: number; /** - * Represents outline level 8. + * Specifies the top margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel8 = "OutlineLevel8", + topMargin: number; /** - * Represents outline level 9. + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel9 = "OutlineLevel9", + verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Represents outline level body text, not an outline level. + * Determines whether lines break automatically to fit text inside the shape. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevelBodyText = "OutlineLevelBodyText", - } - /** - * Specifies the close behavior for `Document.close`. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum CloseBehavior { + wordWrap: boolean; /** - * Saves the changes before closing the document. - * @remarks - * [Api set: WordApi 1.5] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - save = "Save", + set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TextFrame): void; /** - * Discard the possible changes when closing the document. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - skipSave = "SkipSave", - } - /** - * Specifies the save behavior for `Document.save`. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum SaveBehavior { + load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame; /** - * Saves the document without prompting the user. If it's a new document, - it will be saved with the default name or specified name in the default location. - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - save = "Save", + load(propertyNames?: string | string[]): Word.TextFrame; /** - * Displays the "Save As" dialog to the user if the document hasn't been saved. - Won't take effect if the document was previously saved. - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - prompt = "Prompt", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TextFrame; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TextFrame; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TextFrame; + /** + * 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.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TextFrameData; } /** - * Represents the type of {@link Word.Field} object. + * Represents all the properties for wrapping text around a {@link Word.Shape}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - enum FieldType { + class ShapeTextWrap extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Represents that the field type is Add-in. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - addin = "Addin", + bottomDistance: number; /** - * Represents that the field type is AddressBlock. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - addressBlock = "AddressBlock", + leftDistance: number; /** - * Represents that the field type is Advance. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - advance = "Advance", + rightDistance: number; /** - * Represents that the field type is Ask. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - ask = "Ask", + side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Represents that the field type is Author. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - author = "Author", + topDistance: number; /** - * Represents that the field type is AutoText. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - autoText = "AutoText", + type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; /** - * Represents that the field type is AutoTextList. - * @remarks - * [Api set: WordApi 1.5] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - autoTextList = "AutoTextList", + set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeTextWrap): void; /** - * Represents that the field type is Barcode. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - barCode = "BarCode", + load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap; /** - * Represents that the field type is Bibliography. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - bibliography = "Bibliography", + load(propertyNames?: string | string[]): Word.ShapeTextWrap; /** - * Represents that the field type is BidiOutline. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - bidiOutline = "BidiOutline", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShapeTextWrap; /** - * Represents that the field type is Citation. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - citation = "Citation", + track(): Word.ShapeTextWrap; /** - * Represents that the field type is Comments. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - comments = "Comments", + untrack(): Word.ShapeTextWrap; /** - * Represents that the field type is Compare. + * 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.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShapeTextWrapData; + } + /** + * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class Reviewer extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies if the `Reviewer` object is visible. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - compare = "Compare", + isVisible: boolean; /** - * Represents that the field type is CreateDate. - * @remarks - * [Api set: WordApi 1.5] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - createDate = "CreateDate", + set(properties: Interfaces.ReviewerUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Reviewer): void; /** - * Represents that the field type is Data. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - data = "Data", + load(options?: Word.Interfaces.ReviewerLoadOptions): Word.Reviewer; /** - * Represents that the field type is Database. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - database = "Database", + load(propertyNames?: string | string[]): Word.Reviewer; /** - * Represents that the field type is Date. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - date = "Date", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Reviewer; /** - * Represents that the field type is DisplayBarcode. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - displayBarcode = "DisplayBarcode", + track(): Word.Reviewer; /** - * Represents that the field type is DocumentProperty - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - docProperty = "DocProperty", + untrack(): Word.Reviewer; /** - * Represents that the field type is DocumentVariable. - * @remarks - * [Api set: WordApi 1.5] + * 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.Reviewer` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ReviewerData; + } + /** + * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class ReviewerCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Reviewer[]; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - docVariable = "DocVariable", + load(options?: Word.Interfaces.ReviewerCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReviewerCollection; /** - * Represents that the field type is EditTime. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - editTime = "EditTime", + load(propertyNames?: string | string[]): Word.ReviewerCollection; /** - * Represents that the field type is Embedded. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - embedded = "Embedded", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ReviewerCollection; /** - * Represents that the field type is Equation. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - eq = "EQ", + track(): Word.ReviewerCollection; /** - * Represents that the field type is Expression. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - expression = "Expression", + untrack(): Word.ReviewerCollection; /** - * Represents that the field type is FileName. + * 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.ReviewerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ReviewerCollectionData; + } + /** + * Represents the current settings related to the display of reviewers' comments and revision marks in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class RevisionsFilter extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - fileName = "FileName", + readonly reviewers: Word.ReviewerCollection; /** - * Represents that the field type is FileSize. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - fileSize = "FileSize", + markup: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Represents that the field type is FillIn. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - fillIn = "FillIn", + view: Word.RevisionsView | "Final" | "Original"; /** - * Represents that the field type is FormCheckbox. - * @remarks - * [Api set: WordApi 1.5] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - formCheckbox = "FormCheckbox", + set(properties: Interfaces.RevisionsFilterUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RevisionsFilter): void; /** - * Represents that the field type is FormDropdown. + * Shows or hides all revisions in the document that contain comments and tracked changes. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - formDropdown = "FormDropdown", + toggleShowAllReviewers(): void; /** - * Represents that the field type is FormText. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - formText = "FormText", + load(options?: Word.Interfaces.RevisionsFilterLoadOptions): Word.RevisionsFilter; /** - * Represents that the field type is GotoButton. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - gotoButton = "GotoButton", + load(propertyNames?: string | string[]): Word.RevisionsFilter; /** - * Represents that the field type is GreetingLine. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - greetingLine = "GreetingLine", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RevisionsFilter; /** - * Represents that the field type is Hyperlink. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - hyperlink = "Hyperlink", + track(): Word.RevisionsFilter; /** - * Represents that the field type is If. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - if = "If", + untrack(): Word.RevisionsFilter; /** - * Represents that the field type is Import. + * 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.RevisionsFilter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionsFilterData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.RevisionsFilterData; + } + /** + * Represents a single item in a {@link Word.RepeatingSectionContentControl}. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class RepeatingSectionItem extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the range of this repeating section item, excluding the start and end tags. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - import = "Import", + readonly range: Word.Range; /** - * Represents that the field type is Include. - * @remarks - * [Api set: WordApi 1.5] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - include = "Include", + set(properties: Interfaces.RepeatingSectionItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RepeatingSectionItem): void; /** - * Represents that the field type is IncludePicture. + * Deletes this `RepeatingSectionItem` object. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - includePicture = "IncludePicture", + delete(): void; /** - * Represents that the field type is IncludeText. + * Adds a repeating section item after this item and returns the new item. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - includeText = "IncludeText", + insertItemAfter(): Word.RepeatingSectionItem; /** - * Represents that the field type is Index. + * Adds a repeating section item before this item and returns the new item. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - index = "Index", + insertItemBefore(): Word.RepeatingSectionItem; /** - * Represents that the field type is Information. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - info = "Info", + load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; /** - * Represents that the field type is Keywords. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - keywords = "Keywords", + load(propertyNames?: string | string[]): Word.RepeatingSectionItem; /** - * Represents that the field type is LastSavedBy. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - lastSavedBy = "LastSavedBy", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionItem; /** - * Represents that the field type is Link. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - link = "Link", + track(): Word.RepeatingSectionItem; /** - * Represents that the field type is ListNumber. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - listNum = "ListNum", + untrack(): Word.RepeatingSectionItem; /** - * Represents that the field type is MacroButton. + * 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.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.RepeatingSectionItemData; + } + /** + * Represents a collection of {@link Word.RepeatingSectionItem} objects in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class RepeatingSectionItemCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns an individual repeating section item. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] + * + * @param index The index of the item to retrieve. + * @returns A `RepeatingSectionItem` object representing the item at the specified index. */ - macroButton = "MacroButton", + getItemAt(index: number): Word.RepeatingSectionItem; /** - * Represents that the field type is MergeBarcode. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - mergeBarcode = "MergeBarcode", + load(propertyNames?: string | string[]): Word.RepeatingSectionItemCollection; /** - * Represents that the field type is MergeField. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - mergeField = "MergeField", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionItemCollection; /** - * Represents that the field type is MergeRecord. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - mergeRec = "MergeRec", + track(): Word.RepeatingSectionItemCollection; /** - * Represents that the field type is MergeSequence. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - mergeSeq = "MergeSeq", + untrack(): Word.RepeatingSectionItemCollection; /** - * Represents that the field type is Next. + * 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.RepeatingSectionItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Represents a single tracked change in a document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class Revision extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - next = "Next", + readonly movedRange: Word.Range; /** - * Represents that the field type is NextIf. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - nextIf = "NextIf", + readonly range: Word.Range; /** - * Represents that the field type is NoteReference. + * Gets the name of the user who made the tracked change. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - noteRef = "NoteRef", + readonly author: string; /** - * Represents that the field type is NumberOfCharacters. + * Gets the date and time when the tracked change was made. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - numChars = "NumChars", + readonly date: Date; /** - * Represents that the field type is NumberOfPages. + * Gets the description of tracked formatting changes in the revision. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - numPages = "NumPages", + readonly formatDescription: string; /** - * Represents that the field type is NumberOfWords. + * Gets a number that represents the position of this item in a collection. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - numWords = "NumWords", + readonly index: number; /** - * Represents that the field type is ActiveXControl. + * Gets the revision type. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - ocx = "OCX", + readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; /** - * Represents that the field type is Page. - * @remarks - * [Api set: WordApi 1.5] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - page = "Page", + set(properties: Interfaces.RevisionUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Revision): void; /** - * Represents that the field type is PageReference. + * Accepts the tracked change, removes the revision mark, and incorporates the change into the document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - pageRef = "PageRef", + accept(): void; /** - * Represents that the field type is Print. + * Rejects the tracked change. The revision marks are removed, leaving the original text intact. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - print = "Print", + reject(): void; /** - * Represents that the field type is PrintDate. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - printDate = "PrintDate", + load(options?: Word.Interfaces.RevisionLoadOptions): Word.Revision; /** - * Represents that the field type is Private. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - private = "Private", + load(propertyNames?: string | string[]): Word.Revision; /** - * Represents that the field type is Quote. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - quote = "Quote", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Revision; /** - * Represents that the field type is ReferencedDocument. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - rd = "RD", + track(): Word.Revision; /** - * Represents that the field type is Reference. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - ref = "Ref", + untrack(): Word.Revision; /** - * Represents that the field type is RevisionNumber. + * 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.Revision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.RevisionData; + } + /** + * A collection of {@link Word.Revision} objects that represent the changes marked with revision marks in a range or document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class RevisionCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Revision[]; + /** + * Accepts all the tracked changes in the document or range, removes all revision marks, and incorporates the changes into the document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - revNum = "RevNum", + acceptAll(): void; /** - * Represents that the field type is SaveDate. + * Rejects all the tracked changes in the document or range. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - saveDate = "SaveDate", + rejectAll(): void; /** - * Represents that the field type is Section. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - section = "Section", + load(options?: Word.Interfaces.RevisionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RevisionCollection; /** - * Represents that the field type is SectionPages. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - sectionPages = "SectionPages", + load(propertyNames?: string | string[]): Word.RevisionCollection; /** - * Represents that the field type is Sequence. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - seq = "Seq", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RevisionCollection; /** - * Represents that the field type is Set. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - set = "Set", + track(): Word.RevisionCollection; /** - * Represents that the field type is Shape. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - shape = "Shape", + untrack(): Word.RevisionCollection; /** - * Represents that the field type is SkipIf. + * 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.RevisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.RevisionCollectionData; + } + /** + * Represents the `DatePickerContentControl` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class DatePickerContentControl extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - skipIf = "SkipIf", + readonly placeholderText: Word.BuildingBlock; /** - * Represents that the field type is StyleReference. + * Gets a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - styleRef = "StyleRef", + readonly range: Word.Range; /** - * Represents that the field type is Subject. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - subject = "Subject", + readonly xmlMapping: Word.XmlMapping; /** - * Represents that the field type is Subscriber. + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - subscriber = "Subscriber", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Represents that the field type is Symbol. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - symbol = "Symbol", + color: string; /** - * Represents that the field type is TableOfAuthoritiesEntry. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - ta = "TA", + dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Represents that the field type is TableOfContentsEntry. + * Specifies the format in which dates are displayed. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - tc = "TC", + dateDisplayFormat: string; /** - * Represents that the field type is Template. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - template = "Template", + dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Represents that the field type is Time. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - time = "Time", + dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Represents that the field type is Title. + * Gets the identification for the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - title = "Title", + readonly id: string; /** - * Represents that the field type is TableOfAuthorities. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - toa = "TOA", + isTemporary: boolean; /** - * Represents that the field type is TableOfContents. + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - toc = "TOC", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Represents that the field type is UserAddress. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - userAddress = "UserAddress", + lockContentControl: boolean; /** - * Represents that the field type is UserInitials. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - userInitials = "UserInitials", + lockContents: boolean; /** - * Represents that the field type is UserName. + * Gets whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - userName = "UserName", + readonly showingPlaceholderText: boolean; /** - * Represents that the field type is IndexEntry. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - xe = "XE", + tag: string; /** - * Represents that the field type is Empty. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - empty = "Empty", + title: string; /** - * Represents the field types not supported by the Office JavaScript API. - * @remarks - * [Api set: WordApi 1.5] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - others = "Others", + set(properties: Interfaces.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DatePickerContentControl): void; /** - * Represents that the field type is Undefined. + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - undefined = "Undefined", - } - /** - * Represents the kind of {@link Word.Field} object. Indicates how the field works in relation to updating. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum FieldKind { + copy(): void; /** - * Represents that the field is invalid. For example, a pair of field characters with nothing inside. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - none = "None", + cut(): void; /** - * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. + * Deletes this content control and the contents of the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] + * + * @param deleteContents Optional. If `true`, deletes the contents as well. */ - hot = "Hot", + delete(deleteContents?: boolean): void; /** - * Represents that the field is automatically updated when the source changes or the field can be manually updated. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - warm = "Warm", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Represents that the field doesn't have a result. - * @remarks - * [Api set: WordApi 1.5] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - cold = "Cold", - } - /** - * Represents the character inserted after the {@link Word.ListItem | list item} mark. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum TrailingCharacter { + load(options?: Word.Interfaces.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; /** - * A tab is inserted. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - trailingTab = "TrailingTab", + load(propertyNames?: string | string[]): Word.DatePickerContentControl; /** - * A space is inserted. Default. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - trailingSpace = "TrailingSpace", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DatePickerContentControl; /** - * No character is inserted. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - trailingNone = "TrailingNone", + track(): Word.DatePickerContentControl; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.DatePickerContentControl; + /** + * 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.DatePickerContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DatePickerContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.DatePickerContentControlData; } /** - * Represents the built-in number styles for lists in Word. + * Represents the `PictureContentControl` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - enum ListBuiltInNumberStyle { - /** - * No built-in number style. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - none = "None", + class PictureContentControl extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Arabic numerals (1, 2, 3, ...). + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - arabic = "Arabic", + readonly placeholderText: Word.BuildingBlock; /** - * Uppercase Roman numerals (I, II, III, ...). + * Returns a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - upperRoman = "UpperRoman", + readonly range: Word.Range; /** - * Lowercase Roman numerals (i, ii, iii, ...). + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - lowerRoman = "LowerRoman", + readonly xmlMapping: Word.XmlMapping; /** - * Uppercase letters (A, B, C, ...). + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - upperLetter = "UpperLetter", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Lowercase letters (a, b, c, ...). + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - lowerLetter = "LowerLetter", + color: string; /** - * Ordinal numbers (1st, 2nd, 3rd, ...). + * Returns the identification for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - ordinal = "Ordinal", + readonly id: string; /** - * Cardinal numbers as text (one, two, three, ...). + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - cardinalText = "CardinalText", + isTemporary: boolean; /** - * Ordinal numbers as text (first, second, third, ...). + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - ordinalText = "OrdinalText", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Kanji. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - kanji = "Kanji", + lockContentControl: boolean; /** - * Kanji digits. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - kanjiDigit = "KanjiDigit", + lockContents: boolean; /** - * Aiueo half width characters. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - aiueoHalfWidth = "AiueoHalfWidth", + readonly showingPlaceholderText: boolean; /** - * Iroha half width characters. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - irohaHalfWidth = "IrohaHalfWidth", + tag: string; /** - * Arabic full-width numbers. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - arabicFullWidth = "ArabicFullWidth", + title: string; /** - * Traditional Kanji characters. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - kanjiTraditional = "KanjiTraditional", + set(properties: Interfaces.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.PictureContentControl): void; /** - * Traditional Kanji characters (alternative form). + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - kanjiTraditional2 = "KanjiTraditional2", + copy(): void; /** - * Numbers enclosed in a circle. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - numberInCircle = "NumberInCircle", + cut(): void; /** - * Aiueo characters. + * Deletes the content control and optionally its contents. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] + * + * @param deleteContents Optional. Decides whether to delete the contents of the content control. */ - aiueo = "Aiueo", + delete(deleteContents?: boolean): void; /** - * Iroha characters. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - iroha = "Iroha", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Arabic full-width numbers with leading zeros. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - arabicLZ = "ArabicLZ", + load(options?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl; /** - * Bullet characters. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - bullet = "Bullet", + load(propertyNames?: string | string[]): Word.PictureContentControl; /** - * Ganada characters. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - ganada = "Ganada", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.PictureContentControl; /** - * Chosung characters. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - chosung = "Chosung", + track(): Word.PictureContentControl; /** - * GBNum1 characters. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - gbnum1 = "GBNum1", + untrack(): Word.PictureContentControl; /** - * GBNum2 characters. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - gbnum2 = "GBNum2", + * 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.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.PictureContentControlData; + } + /** + * Represents the `GroupContentControl` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class GroupContentControl extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * GBNum3 characters. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - gbnum3 = "GBNum3", + readonly placeholderText: Word.BuildingBlock; /** - * GBNum4 characters. + * Gets a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - gbnum4 = "GBNum4", + readonly range: Word.Range; /** - * Zodiac1 characters. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - zodiac1 = "Zodiac1", + readonly xmlMapping: Word.XmlMapping; /** - * Zodiac2 characters. + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - zodiac2 = "Zodiac2", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Zodiac3 characters. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - zodiac3 = "Zodiac3", + color: string; /** - * Traditional Chinese numbers (style 1). + * Returns the identification for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - tradChinNum1 = "TradChinNum1", + readonly id: string; /** - * Traditional Chinese numbers (style 2). + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - tradChinNum2 = "TradChinNum2", + isTemporary: boolean; /** - * Traditional Chinese numbers (style 3). + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - tradChinNum3 = "TradChinNum3", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Traditional Chinese numbers (style 4). + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - tradChinNum4 = "TradChinNum4", + lockContentControl: boolean; /** - * Simplified Chinese numbers (style 1). + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - simpChinNum1 = "SimpChinNum1", + lockContents: boolean; /** - * Simplified Chinese numbers (style 2). + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - simpChinNum2 = "SimpChinNum2", + readonly showingPlaceholderText: boolean; /** - * Simplified Chinese numbers (style 3). + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - simpChinNum3 = "SimpChinNum3", + tag: string; /** - * Simplified Chinese numbers (style 4). + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - simpChinNum4 = "SimpChinNum4", + title: string; /** - * Hanja read numbers. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - hanjaRead = "HanjaRead", + set(properties: Interfaces.GroupContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.GroupContentControl): void; /** - * Hanja read digits. + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - hanjaReadDigit = "HanjaReadDigit", + copy(): void; /** - * Hangul characters. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - hangul = "Hangul", + cut(): void; /** - * Hanja characters. + * Deletes the content control and optionally its contents. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] + * + * @param deleteContents Optional. Whether to delete the contents inside the control. */ - hanja = "Hanja", + delete(deleteContents: boolean): void; /** - * Hebrew1 characters. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - hebrew1 = "Hebrew1", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Arabic1 characters. + * Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - arabic1 = "Arabic1", + ungroup(): void; /** - * Hebrew2 characters. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - hebrew2 = "Hebrew2", + load(options?: Word.Interfaces.GroupContentControlLoadOptions): Word.GroupContentControl; /** - * Arabic2 characters. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - arabic2 = "Arabic2", + load(propertyNames?: string | string[]): Word.GroupContentControl; /** - * Hindi letter style 1. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - hindiLetter1 = "HindiLetter1", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.GroupContentControl; /** - * Hindi letter style 2. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - hindiLetter2 = "HindiLetter2", + track(): Word.GroupContentControl; /** - * Hindi Arabic style. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - hindiArabic = "HindiArabic", + untrack(): Word.GroupContentControl; /** - * Hindi cardinal text. + * 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.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.GroupContentControlData; + } + /** + * The options that define what placeholder to be used in the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface ContentControlPlaceholderOptions { + /** + * If provided, specifies the `BuildingBlock` object to use as placeholder. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - hindiCardinalText = "HindiCardinalText", + buildingBlock?: Word.BuildingBlock; /** - * Thai letter characters. + * If provided, specifies the `Range` object to use as placeholder. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - thaiLetter = "ThaiLetter", + range?: Word.Range; /** - * Thai Arabic characters. + * If provided, specifies the text to use as placeholder. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - thaiArabic = "ThaiArabic", + text?: string; + } + /** + * Represents the `BuildingBlockGalleryContentControl` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class BuildingBlockGalleryContentControl extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Thai cardinal text. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - thaiCardinalText = "ThaiCardinalText", + readonly placeholderText: Word.BuildingBlock; /** - * Vietnamese cardinal text. + * Returns a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - vietCardinalText = "VietCardinalText", + readonly range: Word.Range; /** - * Lowercase Russian. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - lowercaseRussian = "LowercaseRussian", + readonly xmlMapping: Word.XmlMapping; /** - * Uppercase Russian. + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - uppercaseRussian = "UppercaseRussian", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Lowercase Greek. + * Specifies the category for the building block content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - lowercaseGreek = "LowercaseGreek", + buildingBlockCategory: string; /** - * Uppercase Greek. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - uppercaseGreek = "UppercaseGreek", + buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * Arabic numbers with leading zeros (style 2). + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - arabicLZ2 = "ArabicLZ2", + color: string; /** - * Arabic numbers with leading zeros (style 3). + * Gets the identification for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - arabicLZ3 = "ArabicLZ3", + readonly id: string; /** - * Arabic numbers with leading zeros (style 4). + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - arabicLZ4 = "ArabicLZ4", + isTemporary: boolean; /** - * Lowercase Turkish. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - lowercaseTurkish = "LowercaseTurkish", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Uppercase Turkish. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - uppercaseTurkish = "UppercaseTurkish", + lockContentControl: boolean; /** - * Lowercase Bulgarian. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - lowercaseBulgarian = "LowercaseBulgarian", + lockContents: boolean; /** - * Uppercase Bulgarian. + * Gets if the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - uppercaseBulgarian = "UppercaseBulgarian", + readonly showingPlaceholderText: boolean; /** - * Picture bullet. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - pictureBullet = "PictureBullet", + tag: string; /** - * Legal numbering style. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - legal = "Legal", + title: string; /** - * Legal numbering style with leading zeros. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - legalLZ = "LegalLZ", - } - /** - * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum ShadingTextureType { + set(properties: Interfaces.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.BuildingBlockGalleryContentControl): void; /** - * Represents dark diagonal-down texture. + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - darkDiagonalDown = "DarkDiagonalDown", + copy(): void; /** - * Represents dark diagonal-up texture. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - darkDiagonalUp = "DarkDiagonalUp", + cut(): void; /** - * Represents dark horizontal-cross texture. + * Deletes the content control and optionally its contents. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] + * + * @param deleteContents Optional. Whether to delete the contents inside the control. */ - darkGrid = "DarkGrid", + delete(deleteContents?: boolean): void; /** - * Represents dark horizontal texture. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - darkHorizontal = "DarkHorizontal", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Represents dark diagonal-cross texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - darkTrellis = "DarkTrellis", + load(options?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl; /** - * Represents dark vertical texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - darkVertical = "DarkVertical", + load(propertyNames?: string | string[]): Word.BuildingBlockGalleryContentControl; /** - * Represents light diagonal-down texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - lightDiagonalDown = "LightDiagonalDown", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.BuildingBlockGalleryContentControl; /** - * Represents light diagonal-up texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - lightDiagonalUp = "LightDiagonalUp", + track(): Word.BuildingBlockGalleryContentControl; /** - * Represents light horizontal-cross texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - lightGrid = "LightGrid", + untrack(): Word.BuildingBlockGalleryContentControl; /** - * Represents light horizontal texture. + * 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.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; + } + /** + * Represents the `RepeatingSectionContentControl` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class RepeatingSectionContentControl extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - lightHorizontal = "LightHorizontal", + readonly placeholderText: Word.BuildingBlock; /** - * Represents light diagonal-cross texture. + * Gets a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - lightTrellis = "LightTrellis", + readonly range: Word.Range; /** - * Represents light vertical texture. + * Returns the collection of repeating section items in this repeating section content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - lightVertical = "LightVertical", + readonly repeatingSectionItems: Word.RepeatingSectionItemCollection; /** - * Represents that there's no texture. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - none = "None", + allowInsertDeleteSection: boolean; /** - * Represents 10 percent texture. + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent10 = "Percent10", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Represents 12.5 percent texture. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent12Pt5 = "Percent12Pt5", + color: string; /** - * Represents 15 percent texture. + * Returns the identification for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent15 = "Percent15", + readonly id: string; /** - * Represents 20 percent texture. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent20 = "Percent20", + isTemporary: boolean; /** - * Represents 25 percent texture. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent25 = "Percent25", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Represents 30 percent texture. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - percent30 = "Percent30", - /** - * Represents 35 percent texture. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - percent35 = "Percent35", - /** - * Represents 37.5 percent texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent37Pt5 = "Percent37Pt5", + lockContentControl: boolean; /** - * Represents 40 percent texture. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent40 = "Percent40", + lockContents: boolean; /** - * Represents 45 percent texture. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent45 = "Percent45", + repeatingSectionItemTitle: string; /** - * Represents 5 percent texture. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent5 = "Percent5", + readonly showingPlaceholderText: boolean; /** - * Represents 50 percent texture. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent50 = "Percent50", + tag: string; /** - * Represents 55 percent texture. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent55 = "Percent55", + title: string; /** - * Represents 60 percent texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - percent60 = "Percent60", + set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RepeatingSectionContentControl): void; /** - * Represents 62.5 percent texture. + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent62Pt5 = "Percent62Pt5", + copy(): void; /** - * Represents 65 percent texture. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - percent65 = "Percent65", + cut(): void; /** - * Represents 70 percent texture. + * Deletes the content control and the contents of the content control. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] + * + * @param deleteContents Optional. Whether to delete the contents inside the control. */ - percent70 = "Percent70", + delete(deleteContents?: boolean): void; /** - * Represents 75 percent texture. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - percent75 = "Percent75", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Represents 80 percent texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - percent80 = "Percent80", + load(options?: Word.Interfaces.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl; /** - * Represents 85 percent texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - percent85 = "Percent85", + load(propertyNames?: string | string[]): Word.RepeatingSectionContentControl; /** - * Represents 87.5 percent texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - percent87Pt5 = "Percent87Pt5", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionContentControl; /** - * Represents 90 percent texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - percent90 = "Percent90", + track(): Word.RepeatingSectionContentControl; /** - * Represents 95 percent texture. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - percent95 = "Percent95", + untrack(): Word.RepeatingSectionContentControl; /** - * Represents solid texture. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - solid = "Solid", + * 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.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.RepeatingSectionContentControlData; } /** - * Specifies the target document for displaying document comparison differences. + * Represents one of the readability statistics for the document or range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - enum CompareTarget { + class ReadabilityStatistic extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Places comparison differences in the current document. + * Returns the name of the readability statistic. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - compareTargetCurrent = "CompareTargetCurrent", + readonly name: string; /** - * Places comparison differences in the target document. + * Returns the value of the grammar statistic. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - compareTargetSelected = "CompareTargetSelected", + readonly value: number; /** - * Places comparison differences in a new document. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - compareTargetNew = "CompareTargetNew", - } - /** - * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum ImportedStylesConflictBehavior { + load(options?: Word.Interfaces.ReadabilityStatisticLoadOptions): Word.ReadabilityStatistic; /** - * Ignore conflicting imported styles and keep the existing version of those styles in the current document. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - ignore = "Ignore", + load(propertyNames?: string | string[]): Word.ReadabilityStatistic; /** - * Overwrite the existing styles in the current document. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - overwrite = "Overwrite", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ReadabilityStatistic; /** - * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - createNew = "CreateNew", + track(): Word.ReadabilityStatistic; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ReadabilityStatistic; + /** + * 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.ReadabilityStatistic` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReadabilityStatisticData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ReadabilityStatisticData; } /** - * Represents the shape type. + * Represents a collection of {@link Word.ReadabilityStatistic} objects for the document or range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - enum ShapeType { + class ReadabilityStatisticCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.ReadabilityStatistic[]; /** - * Unsupported shape type. + * Gets the readability statistic at the specified index. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] + * + * @param index The zero-based index of the item to retrieve. */ - unsupported = "Unsupported", + getItemAt(index: number): Word.ReadabilityStatistic; /** - * Text box shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - textBox = "TextBox", + load(options?: Word.Interfaces.ReadabilityStatisticCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReadabilityStatisticCollection; /** - * Geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - geometricShape = "GeometricShape", + load(propertyNames?: string | string[]): Word.ReadabilityStatisticCollection; /** - * Group shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - group = "Group", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ReadabilityStatisticCollection; /** - * Picture shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - picture = "Picture", + track(): Word.ReadabilityStatisticCollection; /** - * Canvas shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - canvas = "Canvas", + untrack(): Word.ReadabilityStatisticCollection; + /** + * 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.ReadabilityStatisticCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReadabilityStatisticCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ReadabilityStatisticCollectionData; } /** - * Represents what the horizontal position of a shape is relative to. - For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * Represents the settings for saving a Word document as a webpage. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - enum RelativeHorizontalPosition { + class WebSettings extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Relative to margin. + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - margin = "Margin", + allowPng: boolean; /** - * Relative to page. + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - page = "Page", + encoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Relative to column. + * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - column = "Column", + readonly folderSuffix: string; /** - * Relative to character. + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - character = "Character", + organizeInFolder: boolean; /** - * Relative to left margin. + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftMargin = "LeftMargin", + pixelsPerInch: number; /** - * Relative to right margin. + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - rightMargin = "RightMargin", + relyOnCSS: boolean; /** - * Relative to inside margin. + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - insideMargin = "InsideMargin", + relyOnVectorMarkupLanguage: boolean; /** - * Relative to outside margin. + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - outsideMargin = "OutsideMargin", - } - /** - * Represents what the vertical position of a shape is relative to. - For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum RelativeVerticalPosition { + screenSize: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** - * Relative to margin. + * Specifies the target browser for documents viewed in a web browser. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - margin = "Margin", + targetBrowser: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** - * Relative to page. + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - page = "Page", + useLongFileNames: boolean; /** - * Relative to paragraph. + * Sets the folder suffix for the specified document to the default suffix for the language support you have selected or installed. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - paragraph = "Paragraph", + useDefaultFolderSuffix(): void; /** - * Relative to line. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - line = "Line", + load(options?: Word.Interfaces.WebSettingsLoadOptions): Word.WebSettings; /** - * Relative to top margin. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - topMargin = "TopMargin", + load(propertyNames?: string | string[]): Word.WebSettings; /** - * Relative to bottom margin. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - bottomMargin = "BottomMargin", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.WebSettings; /** - * Relative to inside margin. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - insideMargin = "InsideMargin", + track(): Word.WebSettings; /** - * Relative to outside margin. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - outsideMargin = "OutsideMargin", + untrack(): Word.WebSettings; + /** + * 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.WebSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WebSettingsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.WebSettingsData; } /** - * Represents what the horizontal or vertical size of a shape is relative to. - For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * Represents the collection of {@link Word.XmlNode} objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - enum RelativeSize { + class XmlNodeCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.XmlNode[]; /** - * Relative to margin. + * Returns an individual `XmlNode` object in a collection. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] + * + * @param index The index of the item to retrieve. */ - margin = "Margin", + getItemAt(index: number): Word.XmlNode; /** - * Relative to page. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - page = "Page", + load(options?: Word.Interfaces.XmlNodeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.XmlNodeCollection; /** - * Relative to top margin. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - topMargin = "TopMargin", + load(propertyNames?: string | string[]): Word.XmlNodeCollection; /** - * Relative to bottom margin. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - bottomMargin = "BottomMargin", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.XmlNodeCollection; /** - * Relative to inside margin. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - insideMargin = "InsideMargin", + track(): Word.XmlNodeCollection; /** - * Relative to outside margin. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - outsideMargin = "OutsideMargin", + untrack(): Word.XmlNodeCollection; + /** + * 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.XmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.XmlNodeCollectionData; } /** - * Specifies the shape type for a {@link Word.GeometricShape} object. + * Provides configuration options for the {@link Word.XmlNode | XmlNode.setValidationError} method. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - enum GeometricShapeType { + interface XmlNodeSetValidationErrorOptions { /** - * Line inverse geometric shape. + * If provided, specifies whether the validation error should be cleared automatically. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - lineInverse = "LineInverse", + clearedAutomatically?: boolean; /** - * Triangle geometric shape. + * If provided, specifies the error text to display for the validation error. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - triangle = "Triangle", + errorText?: string; + } + /** + * Represents a single XML node applied to the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class XmlNode extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Right triangle geometric shape. + * Gets the attributes for this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - rightTriangle = "RightTriangle", + readonly attributes: Word.XmlNodeCollection; /** - * Rectangle geometric shape. + * Gets the child elements of this XML node. Returns an empty collection if the node type is `attribute`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - rectangle = "Rectangle", + readonly childNodes: Word.XmlNodeCollection; /** - * Diamond geometric shape. + * Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - diamond = "Diamond", + readonly firstChild: Word.XmlNode; /** - * Parallelogram geometric shape. + * Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - parallelogram = "Parallelogram", + readonly lastChild: Word.XmlNode; /** - * Trapezoid geometric shape. + * Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - trapezoid = "Trapezoid", + readonly nextSibling: Word.XmlNode; /** - * Non-isosceles trapezoid geometric shape. + * Gets the parent document of this XML node. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", + readonly ownerDocument: Word.Document; /** - * Pentagon geometric shape. + * Gets the parent element of this XML node. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - pentagon = "Pentagon", + readonly parentNode: Word.XmlNode; /** - * Hexagon geometric shape. + * Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - hexagon = "Hexagon", + readonly previousSibling: Word.XmlNode; /** - * Heptagon geometric shape. + * Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - heptagon = "Heptagon", + readonly range: Word.Range; /** - * Octagon geometric shape. + * Gets the name of the element without any prefix. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - octagon = "Octagon", + readonly baseName: string; /** - * Decagon geometric shape. + * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - decagon = "Decagon", + readonly hasChildNodes: boolean; /** - * Dodecagon geometric shape. + * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - dodecagon = "Dodecagon", + readonly level: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Star 4-point geometric shape. + * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - star4 = "Star4", + readonly namespaceUri: string; /** - * Star 5-point geometric shape. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - star5 = "Star5", + placeholderText: string; /** - * Star 6-point geometric shape. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - star6 = "Star6", + text: string; /** - * Star 7-point geometric shape. + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - star7 = "Star7", + readonly validationErrorText: string; /** - * Star 8-point geometric shape. + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - star8 = "Star8", + readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom"; /** - * Star 10-point geometric shape. + * Copies this XML node, excluding XML markup, to the Clipboard. For attribute nodes, copies only the attribute value as text. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - star10 = "Star10", + copy(): void; /** - * Star 12-point geometric shape. + * Removes this XML node from the document and places it on the Clipboard. For attribute nodes, removes the attribute from its parent element and copies only the attribute value as text to the clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - star12 = "Star12", + cut(): void; /** - * Star 16-point geometric shape. + * Deletes the XML node from the XML document. For element nodes, removes the entire element and its content; for attribute nodes, removes the attribute from its parent element. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - star16 = "Star16", + delete(): void; /** - * Star 24-point geometric shape. + * Removes a child element from this XML node. This method has no effect if the node type is `attribute` (since attribute nodes have no child elements). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] + * + * @param childElement The child element to remove. */ - star24 = "Star24", + removeChild(childElement: Word.XmlNode): void; /** - * Star 32-point geometric shape. + * Returns all the child elements that match the XPath parameter, in the order in which they appear within this XML node. Returns `null` if the node type is `attribute` (since attribute nodes have no child elements to search). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] + * + * @param xPath The XPath expression to evaluate. + * @param options Optional. Configuration options for the XPath search. + * @returns A collection of XML nodes that match the XPath expression. */ - star32 = "Star32", + selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection; /** - * Round rectangle geometric shape. + * Returns the first child element that matches the XPath parameter within this XML node. Returns `null` if the node type is `attribute` (since attribute nodes have no child elements to search). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] + * + * @param xPath The XPath expression to evaluate. + * @param options Optional. Configuration options for the XPath search. + * @returns The first XML node that matches the XPath expression, or `null` if no match is found. */ - roundRectangle = "RoundRectangle", + selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode; /** - * Round one rectangle geometric shape. + * Changes the validation error text displayed to a user for this XML node and whether to force Word to report the node as invalid. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] + * + * @param status The validation status to set. + * @param options Optional. Configuration options for setting the validation error. */ - round1Rectangle = "Round1Rectangle", + setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions): void; /** - * Round two same rectangle geometric shape. + * Changes the validation error text displayed to a user for this XML node and whether to force Word to report the node as invalid. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] + * + * @param status The validation status to set. + * @param options Optional. Configuration options for setting the validation error. */ - round2SameRectangle = "Round2SameRectangle", + setValidationError(status: "Ok" | "Custom", options?: Word.XmlNodeSetValidationErrorOptions): void; /** - * Round two diagonal rectangle geometric shape. + * Validates this XML node against the XML schemas that are attached to the document. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - round2DiagonalRectangle = "Round2DiagonalRectangle", + validate(): void; /** - * Snip round rectangle geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - snipRoundRectangle = "SnipRoundRectangle", + load(options?: Word.Interfaces.XmlNodeLoadOptions): Word.XmlNode; /** - * Snip one rectangle geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - snip1Rectangle = "Snip1Rectangle", + load(propertyNames?: string | string[]): Word.XmlNode; /** - * Snip two same rectangle geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - snip2SameRectangle = "Snip2SameRectangle", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.XmlNode; /** - * Snip two diagonal rectangle geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - snip2DiagonalRectangle = "Snip2DiagonalRectangle", + track(): Word.XmlNode; /** - * Plaque geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - plaque = "Plaque", + untrack(): Word.XmlNode; /** - * Ellipse geometric shape. + * 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.XmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlNodeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.XmlNodeData; + } + /** + * Specifies the type of an XML node. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum XmlNodeType { + /** + * Element node. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - ellipse = "Ellipse", + element = "Element", /** - * Teardrop geometric shape. + * Attribute node. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - teardrop = "Teardrop", + attribute = "Attribute", + } + /** + * Specifies the validation status of an XML node. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum XmlValidationStatus { /** - * Home plate geometric shape. + * The node is valid. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - homePlate = "HomePlate", + ok = "Ok", /** - * Chevron geometric shape. + * The node has a custom (user-defined) validation error. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - chevron = "Chevron", + custom = "Custom", + } + /** + * Specifies the level of an XML node. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum XmlNodeLevel { /** - * Pie wedge geometric shape. + * Inline node level. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - pieWedge = "PieWedge", + inline = "Inline", /** - * Pie geometric shape. + * Paragraph node level. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - pie = "Pie", + paragraph = "Paragraph", /** - * Block arc geometric shape. + * Row node level. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - blockArc = "BlockArc", + row = "Row", /** - * Donut geometric shape. + * Cell node level. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - donut = "Donut", + cell = "Cell", + } + /** + * Specifies which Quick Style set to apply to the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ApplyQuickStyleSet { /** - * No smoking geometric shape. + * Resets the Quick Style to the style set in use when the document was opened. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - noSmoking = "NoSmoking", + sessionStart = "SessionStart", /** - * Right arrow geometric shape. + * Resets the Quick Style to the style set from the template, if any. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - rightArrow = "RightArrow", + template = "Template", + } + /** + * Provides configuration options for the {@link Word.XmlNode | XmlNode.selectNodes} and {@link Word.Document| Document.selectNodes} methods. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectNodesOptions { /** - * Left arrow geometric shape. + * If provided, specifies whether to skip text nodes in the search. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftArrow = "LeftArrow", + fastSearchSkippingTextNodes?: boolean; /** - * Up arrow geometric shape. + * If provided, specifies the prefix mapping for the XPath expression. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - upArrow = "UpArrow", + prefixMapping?: string; + } + /** + * Provides configuration options for the {@link Word.XmlNode | XmlNode.selectSingleNode} and {@link Word.Document| Document.selectSingleNode} methods. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectSingleNodeOptions { /** - * Down arrow geometric shape. + * If provided, specifies whether to skip text nodes in the search. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - downArrow = "DownArrow", + fastSearchSkippingTextNodes?: boolean; /** - * Striped right arrow geometric shape. + * If provided, specifies the prefix mapping for the XPath expression. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - stripedRightArrow = "StripedRightArrow", + prefixMapping?: string; + } + /** + * Specifies the screen size for web page preview and HTML export optimization. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ScreenSize { /** - * Notched right arrow geometric shape. + * Screen resolution 544x376 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - notchedRightArrow = "NotchedRightArrow", + size544x376 = "Size544x376", /** - * Bent up arrow geometric shape. + * Screen resolution 640x480 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - bentUpArrow = "BentUpArrow", + size640x480 = "Size640x480", /** - * Left-right arrow geometric shape. + * Screen resolution 720x512 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftRightArrow = "LeftRightArrow", + size720x512 = "Size720x512", /** - * Up-down arrow geometric shape. + * Screen resolution 800x600 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - upDownArrow = "UpDownArrow", + size800x600 = "Size800x600", /** - * Left-up arrow geometric shape. + * Screen resolution 1024x768 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftUpArrow = "LeftUpArrow", + size1024x768 = "Size1024x768", /** - * Left-right-up arrow geometric shape. + * Screen resolution 1152x882 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftRightUpArrow = "LeftRightUpArrow", + size1152x882 = "Size1152x882", /** - * Quad arrow geometric shape. + * Screen resolution 1152x900 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - quadArrow = "QuadArrow", + size1152x900 = "Size1152x900", /** - * Left arrow callout geometric shape. + * Screen resolution 1280x1024 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftArrowCallout = "LeftArrowCallout", + size1280x1024 = "Size1280x1024", /** - * Right arrow callout geometric shape. + * Screen resolution 1600x1200 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - rightArrowCallout = "RightArrowCallout", + size1600x1200 = "Size1600x1200", /** - * Up arrow callout geometric shape. + * Screen resolution 1800x1440 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - upArrowCallout = "UpArrowCallout", + size1800x1440 = "Size1800x1440", /** - * Down arrow callout geometric shape. + * Screen resolution 1920x1200 pixels. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - downArrowCallout = "DownArrowCallout", + size1920x1200 = "Size1920x1200", + } + /** + * Specifies the target web browser for HTML export and web page optimization. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum TargetBrowser { /** - * Left-right arrow callout geometric shape. + * Browser version 3. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftRightArrowCallout = "LeftRightArrowCallout", + v3 = "V3", /** - * Up-down arrow callout geometric shape. + * Browser version 4. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - upDownArrowCallout = "UpDownArrowCallout", + v4 = "V4", /** - * Quad arrow callout geometric shape. + * Microsoft Internet Explorer 4. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - quadArrowCallout = "QuadArrowCallout", + ie4 = "Ie4", /** - * Bent arrow geometric shape. + * Microsoft Internet Explorer 5. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - bentArrow = "BentArrow", + ie5 = "Ie5", /** - * U-turn arrow geometric shape. + * Microsoft Internet Explorer 6. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - uturnArrow = "UturnArrow", + ie6 = "Ie6", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class HtmlDivision extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + readonly htmlDivisions: Word.HtmlDivisionCollection; /** - * Circular arrow geometric shape. + * Gets a `Range` object that represents the portion of a document that's contained in this HTML division. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - circularArrow = "CircularArrow", + readonly range: Word.Range; /** - * Left circular arrow geometric shape. + * Specifies the left indent value (in points) for this HTML division. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftCircularArrow = "LeftCircularArrow", + leftIndent: number; /** - * Left-right circular arrow geometric shape. + * Specifies the right indent (in points) for this HTML division. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftRightCircularArrow = "LeftRightCircularArrow", + rightIndent: number; /** - * Curved right arrow geometric shape. + * Specifies the amount of spacing (in points) after this HTML division. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - curvedRightArrow = "CurvedRightArrow", + spaceAfter: number; /** - * Curved left arrow geometric shape. + * Specifies the spacing (in points) before this HTML division. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - curvedLeftArrow = "CurvedLeftArrow", + spaceBefore: number; /** - * Curved up arrow geometric shape. + * Deletes this HTML division. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - curvedUpArrow = "CurvedUpArrow", + delete(): void; /** - * Curved down arrow geometric shape. + * Returns an `HtmlDivision` object that represents a parent division of the current HTML division. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] + * + * @param levelsUp Optional. The number of levels to go up to retrieve the parent division. */ - curvedDownArrow = "CurvedDownArrow", + htmlDivisionParent(levelsUp?: number): Word.HtmlDivision; /** - * Swoosh arrow geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - swooshArrow = "SwooshArrow", + load(options?: Word.Interfaces.HtmlDivisionLoadOptions): Word.HtmlDivision; /** - * Cube geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - cube = "Cube", + load(propertyNames?: string | string[]): Word.HtmlDivision; /** - * Can geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - can = "Can", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.HtmlDivision; /** - * Lightning bolt geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - lightningBolt = "LightningBolt", + track(): Word.HtmlDivision; /** - * Heart geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - heart = "Heart", + untrack(): Word.HtmlDivision; /** - * Sun geometric shape. + * 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.HtmlDivision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HtmlDivisionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.HtmlDivisionData; + } + /** + * Represents a collection of {@link Word.HtmlDivision} objects in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class HtmlDivisionCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.HtmlDivision[]; + /** + * Returns an `HtmlDivision` object from the collection based on the specified index. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] + * + * @param index The index of the item to retrieve. */ - sun = "Sun", + getItemAt(index: number): Word.HtmlDivision; /** - * Moon geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - moon = "Moon", + load(options?: Word.Interfaces.HtmlDivisionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HtmlDivisionCollection; /** - * Smiley face geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - smileyFace = "SmileyFace", + load(propertyNames?: string | string[]): Word.HtmlDivisionCollection; /** - * Irregular seal 1 geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - irregularSeal1 = "IrregularSeal1", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HtmlDivisionCollection; /** - * Irregular seal 2 geometric shape. + * 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.HtmlDivisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HtmlDivisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.HtmlDivisionCollectionData; + } + /** + * Calendar types. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum CalendarType { + /** + * Western calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - irregularSeal2 = "IrregularSeal2", + western = "Western", /** - * Folded corner geometric shape. + * Arabic calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - foldedCorner = "FoldedCorner", + arabic = "Arabic", /** - * Bevel geometric shape. + * Hebrew calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - bevel = "Bevel", + hebrew = "Hebrew", /** - * Frame geometric shape. + * Taiwan calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - frame = "Frame", + taiwan = "Taiwan", /** - * Half frame geometric shape. + * Japanese calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - halfFrame = "HalfFrame", + japan = "Japan", /** - * Corner geometric shape. + * Thai calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - corner = "Corner", + thai = "Thai", /** - * Diagonal stripe geometric shape. + * Korean calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - diagonalStripe = "DiagonalStripe", + korean = "Korean", /** - * Chord geometric shape. + * Saka Era calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - chord = "Chord", + sakaEra = "SakaEra", /** - * Arc geometric shape. + * Transliterated English calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - arc = "Arc", + translitEnglish = "TranslitEnglish", /** - * Left bracket geometric shape. + * Transliterated French calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - leftBracket = "LeftBracket", + translitFrench = "TranslitFrench", /** - * Right bracket geometric shape. + * Umm al-Qura calendar type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - rightBracket = "RightBracket", + umalqura = "Umalqura", + } + /** + * Date storage formats for {@link Word.DatePickerContentControl}. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ContentControlDateStorageFormat { /** - * Left brace geometric shape. + * Stores the date as text. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - leftBrace = "LeftBrace", + text = "Text", /** - * Right brace geometric shape. + * Stores the date as a date object. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - rightBrace = "RightBrace", + date = "Date", /** - * Bracket pair geometric shape. + * Stores the date as a date-time object. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - bracketPair = "BracketPair", + dateTime = "DateTime", + } + /** + * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class Frame extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * Brace pair geometric shape. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - bracePair = "BracePair", + readonly borders: Word.BorderUniversalCollection; /** - * Callout 1 geometric shape. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - callout1 = "Callout1", + readonly range: Word.Range; /** - * Callout 2 geometric shape. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - callout2 = "Callout2", + readonly shading: Word.ShadingUniversal; /** - * Callout 3 geometric shape. + * Specifies the height (in points) of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - callout3 = "Callout3", + height: number; /** - * Accent callout 1 geometric shape. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - accentCallout1 = "AccentCallout1", + heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Accent callout 2 geometric shape. + * Specifies the horizontal distance between the frame and the surrounding text, in points. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - accentCallout2 = "AccentCallout2", + horizontalDistanceFromText: number; /** - * Accent callout 3 geometric shape. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - accentCallout3 = "AccentCallout3", + horizontalPosition: number; /** - * Border callout 1 geometric shape. + * Specifies if the frame is locked. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - borderCallout1 = "BorderCallout1", + lockAnchor: boolean; /** - * Border callout 2 geometric shape. + * Specifies the relative horizontal position of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - borderCallout2 = "BorderCallout2", + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Border callout 3 geometric shape. + * Specifies the relative vertical position of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - borderCallout3 = "BorderCallout3", + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Accent border callout 1 geometric shape. + * Specifies if document text wraps around the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - accentBorderCallout1 = "AccentBorderCallout1", + textWrap: boolean; /** - * Accent border callout 2 geometric shape. + * Specifies the vertical distance (in points) between the frame and the surrounding text. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - accentBorderCallout2 = "AccentBorderCallout2", + verticalDistanceFromText: number; /** - * Accent border callout 3 geometric shape. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - accentBorderCallout3 = "AccentBorderCallout3", + verticalPosition: number; /** - * Wedge rectangle callout geometric shape. + * Specifies the width (in points) of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - wedgeRectCallout = "WedgeRectCallout", + width: number; /** - * Wedge rounded rectangle callout geometric shape. + * Specifies the rule used to determine the width of the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - wedgeRRectCallout = "WedgeRRectCallout", + widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Wedge ellipse callout geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - wedgeEllipseCallout = "WedgeEllipseCallout", + set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Frame): void; /** - * Cloud callout geometric shape. + * Copies the frame to the Clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - cloudCallout = "CloudCallout", + copy(): void; /** - * Cloud geometric shape. + * Removes the frame from the document and places it on the Clipboard. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - cloud = "Cloud", + cut(): void; /** - * Ribbon geometric shape. + * Deletes the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - ribbon = "Ribbon", + delete(): void; /** - * Ribbon 2 geometric shape. + * Selects the frame. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - ribbon2 = "Ribbon2", + select(): void; /** - * Ellipse ribbon geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - ellipseRibbon = "EllipseRibbon", + load(options?: Word.Interfaces.FrameLoadOptions): Word.Frame; /** - * Ellipse ribbon 2 geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - ellipseRibbon2 = "EllipseRibbon2", + load(propertyNames?: string | string[]): Word.Frame; /** - * Left-right ribbon geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - leftRightRibbon = "LeftRightRibbon", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Frame; /** - * Vertical scroll geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - verticalScroll = "VerticalScroll", + track(): Word.Frame; /** - * Horizontal scroll geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - horizontalScroll = "HorizontalScroll", + untrack(): Word.Frame; /** - * Wave geometric shape. + * 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.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.FrameData; + } + /** + * Represents the collection of {@link Word.Frame} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class FrameCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Frame[]; + /** + * Returns a `Frame` object that represents a new frame added to a range, selection, or document. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] + * + * @param range The range where the frame will be added. + * @returns A `Frame` object that represents the new frame. */ - wave = "Wave", + add(range: Word.Range): Word.Frame; /** - * Double wave geometric shape. + * Deletes the `FrameCollection` object. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - doubleWave = "DoubleWave", + delete(): void; /** - * Plus geometric shape. + * Gets a `Frame` object by its index in the collection. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] + * + * @param index The location of a `Frame` object. */ - plus = "Plus", + getItem(index: number): Word.Frame; /** - * Flow chart process geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - flowChartProcess = "FlowChartProcess", + load(options?: Word.Interfaces.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; /** - * Flow chart decision geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - flowChartDecision = "FlowChartDecision", + load(propertyNames?: string | string[]): Word.FrameCollection; /** - * Flow chart input-output geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - flowChartInputOutput = "FlowChartInputOutput", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FrameCollection; /** - * Flow chart predefined process geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - flowChartPredefinedProcess = "FlowChartPredefinedProcess", + track(): Word.FrameCollection; /** - * Flow chart internal storage geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - flowChartInternalStorage = "FlowChartInternalStorage", + untrack(): Word.FrameCollection; /** - * Flow chart document geometric shape. + * 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.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.FrameCollectionData; + } + /** + * Represents a document library version. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class DocumentLibraryVersion extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets any optional comments associated with this version of the shared document. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - flowChartDocument = "FlowChartDocument", + readonly comments: string; /** - * Flow chart multidocument geometric shape. + * Gets the date and time at which this version of the shared document was last saved to the server. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - flowChartMultidocument = "FlowChartMultidocument", + readonly modified: any; /** - * Flow chart terminator geometric shape. + * Gets the name of the user who last saved this version of the shared document to the server. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - flowChartTerminator = "FlowChartTerminator", + readonly modifiedBy: string; /** - * Flow chart preparation geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - flowChartPreparation = "FlowChartPreparation", + load(options?: Word.Interfaces.DocumentLibraryVersionLoadOptions): Word.DocumentLibraryVersion; /** - * Flow chart manual input geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - flowChartManualInput = "FlowChartManualInput", + load(propertyNames?: string | string[]): Word.DocumentLibraryVersion; /** - * Flow chart manual operation geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - flowChartManualOperation = "FlowChartManualOperation", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DocumentLibraryVersion; /** - * Flow chart connector geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - flowChartConnector = "FlowChartConnector", + track(): Word.DocumentLibraryVersion; /** - * Flow chart punched card geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - flowChartPunchedCard = "FlowChartPunchedCard", + untrack(): Word.DocumentLibraryVersion; /** - * Flow chart punched tape geometric shape. + * 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.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.DocumentLibraryVersionData; + } + /** + * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class DocumentLibraryVersionCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.DocumentLibraryVersion[]; + /** + * Gets a `DocumentLibraryVersion` object by its index in the collection. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] + * + * @param index The location of a `DocumentLibraryVersion` object. */ - flowChartPunchedTape = "FlowChartPunchedTape", + getItem(index: number): Word.DocumentLibraryVersion; /** - * Flow chart summing junction geometric shape. + * Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - flowChartSummingJunction = "FlowChartSummingJunction", + isVersioningEnabled(): OfficeExtension.ClientResult; /** - * Flow chart OR geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - flowChartOr = "FlowChartOr", + load(options?: Word.Interfaces.DocumentLibraryVersionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.DocumentLibraryVersionCollection; /** - * Flow chart collate geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - flowChartCollate = "FlowChartCollate", + load(propertyNames?: string | string[]): Word.DocumentLibraryVersionCollection; /** - * Flow chart sort geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - flowChartSort = "FlowChartSort", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.DocumentLibraryVersionCollection; /** - * Flow chart extract geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - flowChartExtract = "FlowChartExtract", + track(): Word.DocumentLibraryVersionCollection; /** - * Flow chart merge geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - flowChartMerge = "FlowChartMerge", + untrack(): Word.DocumentLibraryVersionCollection; /** - * Flow chart offline storage geometric shape. + * 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.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; + } + /** + * Represents the possible change tracking modes. + * + * @remarks + * [Api set: WordApi 1.4] + */ + enum ChangeTrackingMode { + /** + * ChangeTracking is turned off. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - flowChartOfflineStorage = "FlowChartOfflineStorage", + off = "Off", /** - * Flow chart online storage geometric shape. + * ChangeTracking is turned on for everyone. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - flowChartOnlineStorage = "FlowChartOnlineStorage", + trackAll = "TrackAll", /** - * Flow chart magnetic tape geometric shape. + * Tracking is turned on for my changes only. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - flowChartMagneticTape = "FlowChartMagneticTape", + trackMineOnly = "TrackMineOnly", + } + /** + * Specify the current version or the original version of the text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + enum ChangeTrackingVersion { /** - * Flow chart magnetic disk geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - flowChartMagneticDisk = "FlowChartMagneticDisk", + original = "Original", /** - * Flow chart magnetic drum geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - flowChartMagneticDrum = "FlowChartMagneticDrum", + current = "Current", + } + /** + * Specify the track state when ChangeTracking is on. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum ChangeTrackingState { /** - * Flow chart display geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - flowChartDisplay = "FlowChartDisplay", + unknown = "Unknown", /** - * Flow chart delay geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - flowChartDelay = "FlowChartDelay", + normal = "Normal", /** - * Flow chart alternate process geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - flowChartAlternateProcess = "FlowChartAlternateProcess", + added = "Added", /** - * Flow chart off-page connector geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - flowChartOffpageConnector = "FlowChartOffpageConnector", + deleted = "Deleted", + } + /** + * TrackedChange type. + * + * @remarks + * [Api set: WordApi 1.6] + */ + enum TrackedChangeType { /** - * Action button blank geometric shape. + * No revision. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - actionButtonBlank = "ActionButtonBlank", + none = "None", /** - * Action button home geometric shape. + * Add change. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - actionButtonHome = "ActionButtonHome", + added = "Added", /** - * Action button help geometric shape. + * Delete change. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - actionButtonHelp = "ActionButtonHelp", + deleted = "Deleted", /** - * Action button information geometric shape. + * Format change. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - actionButtonInformation = "ActionButtonInformation", + formatted = "Formatted", + } + /** + * Note item type. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum NoteItemType { /** - * Action button forward next geometric shape. + * Footnote type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - actionButtonForwardNext = "ActionButtonForwardNext", + footnote = "Footnote", /** - * Action button back previous geometric shape. + * Endnote type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - actionButtonBackPrevious = "ActionButtonBackPrevious", + endnote = "Endnote", + } + /** + * Provides information about the type of a raised event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum EventType { /** - * Action button end geometric shape. + * ContentControlDeleted represents the event that the content control has been deleted. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - actionButtonEnd = "ActionButtonEnd", + contentControlDeleted = "ContentControlDeleted", /** - * Action button beginning geometric shape. + * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - actionButtonBeginning = "ActionButtonBeginning", + contentControlSelectionChanged = "ContentControlSelectionChanged", /** - * Action button return geometric shape. + * ContentControlDataChanged represents the event that the data in the content control have been changed. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - actionButtonReturn = "ActionButtonReturn", + contentControlDataChanged = "ContentControlDataChanged", /** - * Action button document geometric shape. + * ContentControlAdded represents the event a content control has been added to the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - actionButtonDocument = "ActionButtonDocument", + contentControlAdded = "ContentControlAdded", /** - * Action button sound geometric shape. + * Represents that a content control has been entered. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - actionButtonSound = "ActionButtonSound", + contentControlEntered = "ContentControlEntered", /** - * Action button movie geometric shape. + * Represents that a content control has been exited. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - actionButtonMovie = "ActionButtonMovie", + contentControlExited = "ContentControlExited", /** - * Gear 6 geometric shape. + * Represents that one or more new paragraphs were added. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - gear6 = "Gear6", + paragraphAdded = "ParagraphAdded", /** - * Gear 9 geometric shape. + * Represents that one or more paragraphs were changed. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - gear9 = "Gear9", + paragraphChanged = "ParagraphChanged", /** - * Funnel geometric shape. + * Represents that one or more paragraphs were deleted. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - funnel = "Funnel", + paragraphDeleted = "ParagraphDeleted", /** - * Math plus geometric shape. + * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - mathPlus = "MathPlus", + annotationClicked = "AnnotationClicked", /** - * Math minus geometric shape. + * Represents that an annotation was hovered over in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - mathMinus = "MathMinus", + annotationHovered = "AnnotationHovered", /** - * Math multiply geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - mathMultiply = "MathMultiply", - /** - * Math divide geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - mathDivide = "MathDivide", - /** - * Math equal geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - mathEqual = "MathEqual", - /** - * Math not equal geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - mathNotEqual = "MathNotEqual", - /** - * Corner tabs geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - cornerTabs = "CornerTabs", - /** - * Square tabs geometric shape. + * Represents that one or more annotations were added in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - squareTabs = "SquareTabs", + annotationInserted = "AnnotationInserted", /** - * Plaque tabs geometric shape. + * Represents that one or more annotations were deleted from the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - plaqueTabs = "PlaqueTabs", + annotationRemoved = "AnnotationRemoved", /** - * Chart X geometric shape. + * Represents an action in the annotation pop-up. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.8] */ - chartX = "ChartX", + annotationPopupAction = "AnnotationPopupAction", + } + /** + * An enum that specifies an event's source. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum EventSource { /** - * Chart star geometric shape. + * Local source. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - chartStar = "ChartStar", + local = "Local", /** - * Chart plus geometric shape. + * Remote source. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - chartPlus = "ChartPlus", + remote = "Remote", } /** - * Specifies a {@link Word.Shape | shape's} fill type. + * Provides information about the content control that raised the `contentControlAdded` event. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - enum ShapeFillType { - /** - * No fill. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - noFill = "NoFill", + interface ContentControlAddedEventArgs { /** - * Solid fill. + * The event type. See `Word.EventType` for details. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - solid = "Solid", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * Gradient fill. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - gradient = "Gradient", + ids: number[]; /** - * Pattern fill. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - pattern = "Pattern", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised the `contentControlDataChanged` event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlDataChangedEventArgs { /** - * Picture fill. + * The event type. See `Word.EventType` for details. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - picture = "Picture", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * Texture fill. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - texture = "Texture", + ids: number[]; /** - * Mixed fill. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - mixed = "Mixed", + source: Word.EventSource | "Local" | "Remote"; } /** - * Specifies the vertical alignment for the text frame in a shape. + * Provides information about the content control that raised the `contentControlDeleted` event. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - enum ShapeTextVerticalAlignment { + interface ContentControlDeletedEventArgs { /** - * Anchor the text at the top of the bounding rectangle. + * The event type. See `Word.EventType` for details. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - top = "Top", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * Anchor the text at the middle of the bounding rectangle. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - middle = "Middle", + ids: number[]; /** - * Anchor the text at the bottom of the bounding rectangle. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - bottom = "Bottom", + source: Word.EventSource | "Local" | "Remote"; } /** - * Specifies the orientation for the text frame in a shape. + * Provides information about the content control that raised the `contentControlEntered` event. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - enum ShapeTextOrientation { - /** - * No orientation, such as in a new geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - none = "None", + interface ContentControlEnteredEventArgs { /** - * Horizontal text. + * The event type. See `Word.EventType` for details. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - horizontal = "Horizontal", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - eastAsianVertical = "EastAsianVertical", + ids: number[]; /** - * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - vertical270 = "Vertical270", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised the `contentControlExited` event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlExitedEventArgs { /** - * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). + * The event type. See `Word.EventType` for details. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - vertical = "Vertical", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - eastAsianHorizontalRotated = "EastAsianHorizontalRotated", + ids: number[]; /** - * A combination of automatic orientation is used. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - mixed = "Mixed", + source: Word.EventSource | "Local" | "Remote"; } /** - * Determines the type of automatic sizing allowed. + * Represents a dropped capital letter in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - enum ShapeAutoSize { + class DropCap extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; /** - * No autosizing. + * Gets the distance (in points) between the dropped capital letter and the paragraph text. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - none = "None", + readonly distanceFromText: number; /** - * The text is adjusted to fit the shape. + * Gets the name of the font for the dropped capital letter. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - textToFitShape = "TextToFitShape", + readonly fontName: string; /** - * The shape is adjusted to fit the text. + * Gets the height (in lines) of the dropped capital letter. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - shapeToFitText = "ShapeToFitText", + readonly linesToDrop: number; /** - * A combination of automatic sizing schemes are used. + * Gets the position of the dropped capital letter. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - mixed = "Mixed", - } - /** - * Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextWrapType { + readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; /** - * Places the shape in line with text. + * Removes the dropped capital letter formatting. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - inline = "Inline", + clear(): void; /** - * Wraps text squarely around the shape. + * Formats the first character in the specified paragraph as a dropped capital letter. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - square = "Square", + enable(): void; /** - * Wraps text close to the shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. */ - tight = "Tight", + load(options?: Word.Interfaces.DropCapLoadOptions): Word.DropCap; /** - * Wraps text around and through the shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - through = "Through", + load(propertyNames?: string | string[]): Word.DropCap; /** - * Places text above and below the shape. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - topBottom = "TopBottom", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DropCap; /** - * Places shape behind text. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - behind = "Behind", + track(): Word.DropCap; /** - * Places shape in front of text. - * @remarks - * [Api set: WordApiDesktop 1.2] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. */ - front = "Front", + untrack(): Word.DropCap; + /** + * 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.DropCap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropCapData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.DropCapData; } /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin. + * Provides information about the content control that raised the `contentControlSelectionChanged` event. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - enum ShapeTextWrapSide { - /** - * Has no wrap side property, such as those for inline shapes. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - none = "None", - /** - * Both left and right sides of the shape. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - both = "Both", + interface ContentControlSelectionChangedEventArgs { /** - * Left side of the shape only. + * The event type. See `Word.EventType` for details. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - left = "Left", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * Right side of the shape only. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - right = "Right", + ids: number[]; /** - * Side of the shape that's farther from the respective page margin. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - largest = "Largest", + source: Word.EventSource | "Local" | "Remote"; } /** - * Specifies the scale size type of a shape. + * Provides information about the paragraphs that raised the `paragraphAdded` event. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - enum ShapeScaleType { + interface ParagraphAddedEventArgs { /** - * Scale from current size of the shape. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - currentSize = "CurrentSize", + source: Word.EventSource | "Local" | "Remote"; /** - * Scale from original size of the shape. It only works for pictures. + * The event type. See `Word.EventType` for details. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - originalSize = "OriginalSize", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + /** + * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * + * @remarks + * [Api set: WordApi 1.6] + */ + uniqueLocalIds: string[]; } /** - * Specifies which part of the shape retains its position when the shape is scaled. + * Provides information about the paragraphs that raised the `paragraphChanged` event. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - enum ShapeScaleFrom { + interface ParagraphChangedEventArgs { /** - * Scale from the top left corner of the shape. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - scaleFromTopLeft = "ScaleFromTopLeft", + source: Word.EventSource | "Local" | "Remote"; /** - * Scale from the center of the shape. + * The event type. See `Word.EventType` for details. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - scaleFromMiddle = "ScaleFromMiddle", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * Scale from the bottom right corner of the shape. + * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - scaleFromBottomRight = "ScaleFromBottomRight", + uniqueLocalIds: string[]; } /** - * Represents how Word interprets the rule used to determine the height or width of a {@link Word.Frame}. + * Provides information about the paragraphs that raised the `paragraphDeleted` event. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - enum FrameSizeRule { + interface ParagraphDeletedEventArgs { /** - * The height or width is set according to the height or width of the item in the frame. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - auto = "Auto", + source: Word.EventSource | "Local" | "Remote"; /** - * The height or width is set to a value equal to or greater than the value specified by the `height` property or `width` property. + * The event type. See `Word.EventType` for details. + * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - atLeast = "AtLeast", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * The height or width is set to an exact value specified by the `height` property or `width` property. + * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - exact = "Exact", + uniqueLocalIds: string[]; } /** - * Specifies the {@link Word.BorderUniversal | border } style for an object. + * Specifies supported content control types and subtypes. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - enum BorderLineStyle { + enum ContentControlType { /** - * No line style. + * Unknown content control type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - none = "None", + unknown = "Unknown", /** - * Single line style. + * Rich text content control subtype containing inline elements. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - single = "Single", + richTextInline = "RichTextInline", /** - * Dotted line style. + * Rich text content control subtype containing paragraphs. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - dot = "Dot", + richTextParagraphs = "RichTextParagraphs", /** - * Dashed line style with small gaps. + * Rich text content control subtype containing a whole cell. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - dashSmallGap = "DashSmallGap", + richTextTableCell = "RichTextTableCell", /** - * Dashed line style with large gaps. + * Rich text content control subtype containing a whole row. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - dashLargeGap = "DashLargeGap", + richTextTableRow = "RichTextTableRow", /** - * Dash-dot line style. + * Rich text content control subtype containing a whole table. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - dashDot = "DashDot", + richTextTable = "RichTextTable", /** - * Dash-dot-dot line style. + * Plain text content control subtype containing inline elements. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - dashDotDot = "DashDotDot", + plainTextInline = "PlainTextInline", /** - * Double line style. + * Plain text content control subtype containing paragraphs. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - double = "Double", + plainTextParagraph = "PlainTextParagraph", /** - * Triple line style. + * Picture content control (type and subtype). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - triple = "Triple", + picture = "Picture", /** - * Thin-thick line style with small gaps. + * Building block gallery content control (type and subtype). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - thinThickSmallGap = "ThinThickSmallGap", + buildingBlockGallery = "BuildingBlockGallery", /** - * Thick-thin line style with small gaps. + * Check box content control (type and subtype). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - thickThinSmallGap = "ThickThinSmallGap", + checkBox = "CheckBox", /** - * Thin-thick-thin line style with small gaps. + * Combo box content control (type and subtype). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - thinThickThinSmallGap = "ThinThickThinSmallGap", + comboBox = "ComboBox", /** - * Thin-thick line style with medium gaps. + * Dropdown list content control (type and subtype). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - thinThickMedGap = "ThinThickMedGap", + dropDownList = "DropDownList", /** - * Thick-thin line style with medium gaps. + * Date picker content control (type and subtype). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - thickThinMedGap = "ThickThinMedGap", + datePicker = "DatePicker", /** - * Thin-thick-thin line style with medium gaps. + * Repeating section content control (type and subtype). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - thinThickThinMedGap = "ThinThickThinMedGap", + repeatingSection = "RepeatingSection", /** - * Thin-thick line style with large gaps. + * Rich text content control type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - thinThickLargeGap = "ThinThickLargeGap", + richText = "RichText", /** - * Thick-thin line style with large gaps. + * Plain text content control type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - thickThinLargeGap = "ThickThinLargeGap", + plainText = "PlainText", /** - * Thin-thick-thin line style with large gaps. + * Group content control type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - thinThickThinLargeGap = "ThinThickThinLargeGap", + group = "Group", + } + /** + * Represents the content control appearance. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum ContentControlAppearance { /** - * Single wavy line style. + * Represents a content control shown as a shaded rectangle or bounding box (with optional title). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - singleWavy = "SingleWavy", + boundingBox = "BoundingBox", /** - * Double wavy line style. + * Represents a content control shown as start and end markers. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - doubleWavy = "DoubleWavy", + tags = "Tags", /** - * Dash-dot stroked line style. + * Represents a content control that isn't shown. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - dashDotStroked = "DashDotStroked", + hidden = "Hidden", + } + /** + * Represents the content control level type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ContentControlLevel { /** - * Embossed 3D line style. + * Represents an inline content control. * @remarks * [Api set: WordApiDesktop 1.3] */ - emboss3D = "Emboss3D", + inline = "Inline", /** - * Engraved 3D line style. + * Represents a paragraph-level content control. * @remarks * [Api set: WordApiDesktop 1.3] */ - engrave3D = "Engrave3D", + paragraph = "Paragraph", /** - * Outset line style. + * Represents a row-level content control. * @remarks * [Api set: WordApiDesktop 1.3] */ - outset = "Outset", + row = "Row", /** - * Inset line style. + * Represents a cell-level content control. * @remarks * [Api set: WordApiDesktop 1.3] */ - inset = "Inset", + cell = "Cell", } /** - * Specifies the width of an object's {@link Word.BorderUniversal | border}. + * Represents the supported styles for underline format. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - enum LineWidth { + enum UnderlineType { /** - * Represents a line width of 0.25 points. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pt025 = "Pt025", + mixed = "Mixed", /** - * Represents a line width of 0.50 points. + * No underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pt050 = "Pt050", + none = "None", /** - * Represents a line width of 0.75 points. + * Warning: hidden has been deprecated. + * @deprecated Hidden is no longer supported. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pt075 = "Pt075", + hidden = "Hidden", /** - * Represents a line width of 1.00 points. + * Warning: dotLine has been deprecated. + * @deprecated DotLine is no longer supported. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pt100 = "Pt100", + dotLine = "DotLine", /** - * Represents a line width of 1.50 points. + * A single underline. This is the default value. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pt150 = "Pt150", + single = "Single", /** - * Represents a line width of 2.25 points. + * Only underline individual words. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pt225 = "Pt225", + word = "Word", /** - * Represents a line width of 3.00 points. + * A double underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pt300 = "Pt300", + double = "Double", /** - * Represents a line width of 4.50 points. + * A single thick underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pt450 = "Pt450", + thick = "Thick", /** - * Represents a line width of 6.00 points. + * A dotted underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pt600 = "Pt600", - } - /** - * Specifies the graphical page border setting of a page. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum PageBorderArt { + dotted = "Dotted", /** - * Represents a border with apple design. + * A heavy dotted underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - apples = "Apples", + dottedHeavy = "DottedHeavy", /** - * Represents a border with maple muffin design. + * A single dash underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - mapleMuffins = "MapleMuffins", + dashLine = "DashLine", /** - * Represents a border with cake slice design. + * A heavy dash underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - cakeSlice = "CakeSlice", + dashLineHeavy = "DashLineHeavy", /** - * Represents a border with candy corn design. + * A long dash underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - candyCorn = "CandyCorn", + dashLineLong = "DashLineLong", /** - * Represents a border with ice cream cone design. + * A long heavy dash underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - iceCreamCones = "IceCreamCones", + dashLineLongHeavy = "DashLineLongHeavy", /** - * Represents a border with champagne bottle design. + * An alternating dot-dash underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - champagneBottle = "ChampagneBottle", + dotDashLine = "DotDashLine", /** - * Represents a border with party glass design. + * A heavy dot-dash underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - partyGlass = "PartyGlass", + dotDashLineHeavy = "DotDashLineHeavy", /** - * Represents a border with Christmas tree design. + * An alternating dot-dot-dash underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - christmasTree = "ChristmasTree", + twoDotDashLine = "TwoDotDashLine", /** - * Represents a border with trees design. + * An alternating heavy dot-dot-dash underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - trees = "Trees", + twoDotDashLineHeavy = "TwoDotDashLineHeavy", /** - * Represents a border with palm trees in color. + * A single wavy underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - palmsColor = "PalmsColor", + wave = "Wave", /** - * Represents a border with three-color balloons design. + * A heavy wavy underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - balloons3Colors = "Balloons3Colors", + waveHeavy = "WaveHeavy", /** - * Represents a border with hot air balloons design. + * A double wavy underline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - balloonsHotAir = "BalloonsHotAir", + waveDouble = "WaveDouble", + } + /** + * Specifies the form of a break. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum BreakType { /** - * Represents a border with party favor design. + * Page break at the insertion point. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - partyFavor = "PartyFavor", + page = "Page", /** - * Represents a border with confetti streamers design. + * Warning: next has been deprecated. Use sectionNext instead. + * @deprecated Use sectionNext instead. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - confettiStreamers = "ConfettiStreamers", + next = "Next", /** - * Represents a border with hearts design. + * Section break on next page. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - hearts = "Hearts", + sectionNext = "SectionNext", /** - * Represents a border with heart balloon design. + * New section without a corresponding page break. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - heartBalloon = "HeartBalloon", + sectionContinuous = "SectionContinuous", /** - * Represents a border with 3D stars design. + * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - stars3D = "Stars3D", + sectionEven = "SectionEven", /** - * Represents a border with shadowed stars design. + * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - starsShadowed = "StarsShadowed", + sectionOdd = "SectionOdd", /** - * Represents a border with stars design. + * Line break. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - stars = "Stars", + line = "Line", + } + /** + * Represents the insertion location type. + * + * @remarks + * [Api set: WordApi 1.1] + * + * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. + * If the location is `before` or `after`, the new content will be outside of the modified object. + * If the location is `start` or `end`, the new content will be included as part of the modified object. + */ + enum InsertLocation { /** - * Represents a border with sun design. + * Add content before the contents of the calling object. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - sun = "Sun", + before = "Before", /** - * Represents a border with Earth design (variant 2). + * Add content after the contents of the calling object. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - earth2 = "Earth2", + after = "After", /** - * Represents a border with Earth design (variant 1). + * Prepend content to the contents of the calling object. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - earth1 = "Earth1", + start = "Start", /** - * Represents a border with people wearing hats design. + * Append content to the contents of the calling object. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - peopleHats = "PeopleHats", + end = "End", /** - * Represents a border with sombrero design. + * Replace the contents of the current object. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - sombrero = "Sombrero", + replace = "Replace", + } + /** + * Represents the horizontal alignment of text. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum Alignment { /** - * Represents a border with pencils design. + * Mixed horizontal alignment. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pencils = "Pencils", + mixed = "Mixed", /** - * Represents a border with packages design. + * Unknown alignment. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - packages = "Packages", + unknown = "Unknown", /** - * Represents a border with clocks design. + * Alignment to the left. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - clocks = "Clocks", + left = "Left", /** - * Represents a border with firecrackers design. + * Alignment to the center. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - firecrackers = "Firecrackers", + centered = "Centered", /** - * Represents a border with rings design. + * Alignment to the right. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - rings = "Rings", + right = "Right", /** - * Represents a border with map pins design. + * Fully justified alignment. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - mapPins = "MapPins", + justified = "Justified", + } + /** + * Represents the type of header or footer. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum HeaderFooterType { /** - * Represents a border with confetti design. + * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - confetti = "Confetti", + primary = "Primary", /** - * Represents a border with butterfly creatures design. + * Returns the header or footer on the first page of a section. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - creaturesButterfly = "CreaturesButterfly", + firstPage = "FirstPage", /** - * Represents a border with ladybug creatures design. + * Returns all headers or footers on even-numbered pages of a section. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - creaturesLadyBug = "CreaturesLadyBug", + evenPages = "EvenPages", + } + /** + * Represents the types of `Body` objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum BodyType { /** - * Represents a border with fish creatures design. + * Unknown body type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - creaturesFish = "CreaturesFish", + unknown = "Unknown", /** - * Represents a border with birds in flight design. + * Main document body. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - birdsFlight = "BirdsFlight", + mainDoc = "MainDoc", /** - * Represents a border with scared cat design. + * Section body. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - scaredCat = "ScaredCat", + section = "Section", /** - * Represents a border with bats design. + * Header body. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - bats = "Bats", + header = "Header", /** - * Represents a border with roses flowers design. + * Footer body. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - flowersRoses = "FlowersRoses", + footer = "Footer", /** - * Represents a border with red rose flowers design. + * Table cell body. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - flowersRedRose = "FlowersRedRose", + tableCell = "TableCell", /** - * Represents a border with poinsettias flowers design. + * Footnote body. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - poinsettias = "Poinsettias", + footnote = "Footnote", /** - * Represents a border with holly design. + * Endnote body. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - holly = "Holly", + endnote = "Endnote", /** - * Represents a border with tiny flowers design. + * Note body e.g., endnote, footnote. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - flowersTiny = "FlowersTiny", + noteItem = "NoteItem", + } + /** + * Represents where the cursor (insertion point) is set in the document after a selection. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SelectionMode { /** - * Represents a border with pansy flowers design. + * The entire range is selected. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - flowersPansy = "FlowersPansy", + select = "Select", /** - * Represents a border with modern 2 flowers design. + * The cursor is at the beginning of the selection (just before the start of the selected range). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - flowersModern2 = "FlowersModern2", + start = "Start", /** - * Represents a border with modern 1 flowers design. + * The cursor is at the end of the selection (just after the end of the selected range). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - flowersModern1 = "FlowersModern1", + end = "End", + } + /** + * Represents image format type. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ImageFormat { /** - * Represents a border with white flowers design. + * Unsupported image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - whiteFlowers = "WhiteFlowers", + unsupported = "Unsupported", /** - * Represents a border with vine design. + * Undefined image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - vine = "Vine", + undefined = "Undefined", /** - * Represents a border with daisies flowers design. + * Bitmap image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - flowersDaisies = "FlowersDaisies", + bmp = "Bmp", /** - * Represents a border with block print flowers design. + * JPEG image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - flowersBlockPrint = "FlowersBlockPrint", + jpeg = "Jpeg", /** - * Represents a border with colored deco arch design. + * GIF image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - decoArchColor = "DecoArchColor", + gif = "Gif", /** - * Represents a border with fans design. + * TIFF image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - fans = "Fans", + tiff = "Tiff", /** - * Represents a border with film design. + * PNG image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - film = "Film", + png = "Png", /** - * Represents a border with lightning design (variant 1). + * Icon image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - lightning1 = "Lightning1", + icon = "Icon", /** - * Represents a border with compass design. + * Exif image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - compass = "Compass", + exif = "Exif", /** - * Represents a border with double D design. + * Windows Metafile image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - doubleD = "DoubleD", + wmf = "Wmf", /** - * Represents a border with classical wave design. + * Enhanced Metafile image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - classicalWave = "ClassicalWave", + emf = "Emf", /** - * Represents a border with shadowed squares design. + * PICT image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - shadowedSquares = "ShadowedSquares", + pict = "Pict", /** - * Represents a border with twisted lines design (variant 1). + * PDF image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - twistedLines1 = "TwistedLines1", + pdf = "Pdf", /** - * Represents a border with waveline design. + * SVG image format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - waveline = "Waveline", + svg = "Svg", + } + /** + * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum RangeLocation { /** - * Represents a border with quadrants design. + * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - quadrants = "Quadrants", + whole = "Whole", /** - * Represents a border with colored checked bar design. + * The starting point of the object. For content control, it's the point after the opening tag. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - checkedBarColor = "CheckedBarColor", + start = "Start", /** - * Represents a border with swirligig design. + * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - swirligig = "Swirligig", + end = "End", /** - * Represents a border with push pin note design (variant 1). + * For content control only. It's the point before the opening tag. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - pushPinNote1 = "PushPinNote1", + before = "Before", /** - * Represents a border with push pin note design (variant 2). + * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - pushPinNote2 = "PushPinNote2", + after = "After", /** - * Represents a border with pumpkin design (variant 1). + * The range between `start` and `end`. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - pumpkin1 = "Pumpkin1", + content = "Content", + } + /** + * Represents the relationship of the location of this instance to another range. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum LocationRelation { /** - * Represents a border with black eggs design. + * Indicates that this instance and the range are in different subdocuments. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - eggsBlack = "EggsBlack", + unrelated = "Unrelated", /** - * Represents a border with cup design. + * Indicates that this instance and the range represent the same range. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - cup = "Cup", + equal = "Equal", /** - * Represents a border with gray heart design. + * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - heartGray = "HeartGray", + containsStart = "ContainsStart", /** - * Represents a border with gingerbread man design. + * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - gingerbreadMan = "GingerbreadMan", + containsEnd = "ContainsEnd", /** - * Represents a border with baby pacifier design. + * Indicates that this instance contains the range, with the exception of the start and end character of this instance. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - babyPacifier = "BabyPacifier", + contains = "Contains", /** - * Represents a border with baby rattle design. + * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - babyRattle = "BabyRattle", + insideStart = "InsideStart", /** - * Represents a border with cabins design. + * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - cabins = "Cabins", + insideEnd = "InsideEnd", /** - * Represents a border with funky house design. + * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - houseFunky = "HouseFunky", + inside = "Inside", /** - * Represents a border with black stars design. + * Indicates that this instance occurs before, and is adjacent to, the range. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - starsBlack = "StarsBlack", + adjacentBefore = "AdjacentBefore", /** - * Represents a border with snowflakes design. + * Indicates that this instance starts before the range and overlaps the range's first character. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - snowflakes = "Snowflakes", + overlapsBefore = "OverlapsBefore", /** - * Represents a border with fancy snowflake design. + * Indicates that this instance occurs before the range. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - snowflakeFancy = "SnowflakeFancy", + before = "Before", /** - * Represents a border with skyrocket design. + * Indicates that this instance occurs after, and is adjacent to, the range. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - skyrocket = "Skyrocket", + adjacentAfter = "AdjacentAfter", /** - * Represents a border with Seattle design. + * Indicates that this instance starts inside the range and overlaps the range’s last character. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - seattle = "Seattle", + overlapsAfter = "OverlapsAfter", /** - * Represents a border with music notes design. + * Indicates that this instance occurs after the range. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - musicNotes = "MusicNotes", + after = "After", + } + /** + * Represents the location of a {@link https://learn.microsoft.com/javascript/api/word/word.border | border}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderLocation { /** - * Represents a border with black palms design. + * Top border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - palmsBlack = "PalmsBlack", + top = "Top", /** - * Represents a border with maple leaf design. + * Left border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - mapleLeaf = "MapleLeaf", + left = "Left", /** - * Represents a border with paper clips design. + * Bottom border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - paperClips = "PaperClips", + bottom = "Bottom", /** - * Represents a border with shorebird tracks design. + * Right border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - shorebirdTracks = "ShorebirdTracks", + right = "Right", /** - * Represents a border with people design. + * Inside horizontal border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - people = "People", + insideHorizontal = "InsideHorizontal", /** - * Represents a border with people waving design. + * Inside vertical border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - peopleWaving = "PeopleWaving", + insideVertical = "InsideVertical", /** - * Represents a border with eclipsing squares design (variant 2). + * Inside border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - eclipsingSquares2 = "EclipsingSquares2", + inside = "Inside", /** - * Represents a border with hypnotic design. + * Outside border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - hypnotic = "Hypnotic", + outside = "Outside", /** - * Represents a border with gray diamonds design. + * All borders. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - diamondsGray = "DiamondsGray", + all = "All", + } + /** + * Represents the location of cell padding. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum CellPaddingLocation { /** - * Represents a border with deco arch design. + * Padding at the top of the cell. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - decoArch = "DecoArch", + top = "Top", /** - * Represents a border with deco blocks design. + * Padding at the left of the cell. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - decoBlocks = "DecoBlocks", + left = "Left", /** - * Represents a border with circles and lines design. + * Padding at the bottom of the cell. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - circlesLines = "CirclesLines", + bottom = "Bottom", /** - * Represents a border with papyrus design. + * Padding at the right of the cell. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - papyrus = "Papyrus", + right = "Right", + } + /** + * Represents the width of a style's border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum BorderWidth { /** - * Represents a border with woodwork design. + * None width. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - woodwork = "Woodwork", + none = "None", /** - * Represents a border with weaving braid design. + * 0.25 point. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - weavingBraid = "WeavingBraid", + pt025 = "Pt025", /** - * Represents a border with weaving ribbon design. + * 0.50 point. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - weavingRibbon = "WeavingRibbon", + pt050 = "Pt050", /** - * Represents a border with weaving angles design. + * 0.75 point. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - weavingAngles = "WeavingAngles", + pt075 = "Pt075", /** - * Represents a border with arched scallops design. + * 1.00 point. This is the default. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - archedScallops = "ArchedScallops", + pt100 = "Pt100", /** - * Represents a border with safari design. + * 1.50 points. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - safari = "Safari", + pt150 = "Pt150", /** - * Represents a border with Celtic knotwork design. + * 2.25 points. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - celticKnotwork = "CelticKnotwork", + pt225 = "Pt225", /** - * Represents a border with crazy maze design. + * 3.00 points. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - crazyMaze = "CrazyMaze", + pt300 = "Pt300", /** - * Represents a border with eclipsing squares design (variant 1). + * 4.50 points. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - eclipsingSquares1 = "EclipsingSquares1", + pt450 = "Pt450", /** - * Represents a border with birds design. + * 6.00 points. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - birds = "Birds", + pt600 = "Pt600", /** - * Represents a border with teacup and flowers design. + * Mixed width. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - flowersTeacup = "FlowersTeacup", + mixed = "Mixed", + } + /** + * The {@link https://learn.microsoft.com/javascript/api/word/word.border | border} types. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderType { /** - * Represents a border with northwest design. + * Mixed border type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - northwest = "Northwest", + mixed = "Mixed", /** - * Represents a border with southwest design. + * No border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - southwest = "Southwest", + none = "None", /** - * Represents a border with tribal design (variant 6). + * Single border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - tribal6 = "Tribal6", + single = "Single", /** - * Represents a border with tribal design (variant 4). + * Double border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - tribal4 = "Tribal4", + double = "Double", /** - * Represents a border with tribal design (variant 3). + * Dotted border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - tribal3 = "Tribal3", + dotted = "Dotted", /** - * Represents a border with tribal design (variant 2). + * Dashed border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - tribal2 = "Tribal2", + dashed = "Dashed", /** - * Represents a border with tribal design (variant 5). + * Dot-dashed border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - tribal5 = "Tribal5", + dotDashed = "DotDashed", /** - * Represents a border with X illusions design. + * Double dot-dashed border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - xillusions = "XIllusions", + dot2Dashed = "Dot2Dashed", /** - * Represents a border with zany triangles design. + * Triple border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - zanyTriangles = "ZanyTriangles", + triple = "Triple", /** - * Represents a border with pyramids design. + * Thin-thick small border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - pyramids = "Pyramids", + thinThickSmall = "ThinThickSmall", /** - * Represents a border with pyramids above design. + * Thick-thin small border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - pyramidsAbove = "PyramidsAbove", + thickThinSmall = "ThickThinSmall", /** - * Represents a border with gray confetti design. + * Thin-thick-thin small border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - confettiGrays = "ConfettiGrays", + thinThickThinSmall = "ThinThickThinSmall", /** - * Represents a border with outline confetti design. + * Thin-thick medium border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - confettiOutline = "ConfettiOutline", + thinThickMed = "ThinThickMed", /** - * Represents a border with white confetti design. + * Thick-thin medium border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - confettiWhite = "ConfettiWhite", + thickThinMed = "ThickThinMed", /** - * Represents a border with mosaic design. + * Thin-thick-thin medium border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - mosaic = "Mosaic", + thinThickThinMed = "ThinThickThinMed", /** - * Represents a border with lightning design (variant 2). + * Thin-thick large border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - lightning2 = "Lightning2", + thinThickLarge = "ThinThickLarge", /** - * Represents a border with heebie jeebies design. + * Thick-thin large border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - heebieJeebies = "HeebieJeebies", + thickThinLarge = "ThickThinLarge", /** - * Represents a border with light bulb design. + * Thin-thick-thin large border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - lightBulb = "LightBulb", + thinThickThinLarge = "ThinThickThinLarge", /** - * Represents a border with gradient design. + * Wave border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - gradient = "Gradient", + wave = "Wave", /** - * Represents a border with triangle party design. + * Double wave border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - triangleParty = "TriangleParty", + doubleWave = "DoubleWave", /** - * Represents a border with twisted lines design (variant 2). + * Dashed small border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - twistedLines2 = "TwistedLines2", + dashedSmall = "DashedSmall", /** - * Represents a border with moons design. + * Dash-dot-stroked border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - moons = "Moons", + dashDotStroked = "DashDotStroked", /** - * Represents a border with ovals design. + * 3D Emboss border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - ovals = "Ovals", + threeDEmboss = "ThreeDEmboss", /** - * Represents a border with double diamonds design. + * 3D Engrave border. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - doubleDiamonds = "DoubleDiamonds", + threeDEngrave = "ThreeDEngrave", + } + /** + * Represents the vertical alignment of text. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum VerticalAlignment { /** - * Represents a border with chain link design. + * Mixed vertical alignment. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - chainLink = "ChainLink", + mixed = "Mixed", /** - * Represents a border with triangles design. + * Top vertical alignment. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - triangles = "Triangles", + top = "Top", /** - * Represents a border with tribal design (variant 1). + * Center vertical alignment. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - tribal1 = "Tribal1", + center = "Center", /** - * Represents a border with marquee toothed design. + * Bottom vertical alignment. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - marqueeToothed = "MarqueeToothed", + bottom = "Bottom", + } + /** + * Represents the type of list level. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListLevelType { /** - * Represents a border with sharks teeth design. + * Represents the bullet type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - sharksTeeth = "SharksTeeth", + bullet = "Bullet", /** - * Represents a border with sawtooth design. + * Represents the numbering type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - sawtooth = "Sawtooth", + number = "Number", /** - * Represents a border with gray sawtooth design. + * Represents the picture type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - sawtoothGray = "SawtoothGray", + picture = "Picture", + } + /** + * Represents the bullet style in a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListBullet { /** - * Represents a border with postage stamp design. + * Represents custom bullet. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - postageStamp = "PostageStamp", + custom = "Custom", /** - * Represents a border with weaving strips design. + * Represents solid bullet. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - weavingStrips = "WeavingStrips", + solid = "Solid", /** - * Represents a border with zigzag design. + * Represents hollow bullet. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - zigZag = "ZigZag", + hollow = "Hollow", /** - * Represents a border with cross stitch design. + * Represents square bullet. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - crossStitch = "CrossStitch", + square = "Square", /** - * Represents a border with gems design. + * Represents diamond bullet. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - gems = "Gems", + diamonds = "Diamonds", /** - * Represents a border with circles and rectangles design. + * Represents arrow bullet. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - circlesRectangles = "CirclesRectangles", + arrow = "Arrow", /** - * Represents a border with corner triangles design. + * Represents checkmark bullet. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - cornerTriangles = "CornerTriangles", + checkmark = "Checkmark", + } + /** + * Represents the numbering style in a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListNumbering { /** - * Represents a border with insects creatures design. + * Represents no numbering. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - creaturesInsects = "CreaturesInsects", + none = "None", /** - * Represents a border with zigzag stitch design. + * Represents Arabic numbering. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - zigZagStitch = "ZigZagStitch", + arabic = "Arabic", /** - * Represents a border with checkered design. + * Represents upper Roman numeral numbering. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - checkered = "Checkered", + upperRoman = "UpperRoman", /** - * Represents a border with black checked bar design. + * Represents lower Roman numeral numbering. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - checkedBarBlack = "CheckedBarBlack", + lowerRoman = "LowerRoman", /** - * Represents a border with marquee design. + * Represents upper letter numbering. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - marquee = "Marquee", + upperLetter = "UpperLetter", /** - * Represents a border with basic white dots design. + * Represents lower letter numbering. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basicWhiteDots = "BasicWhiteDots", + lowerLetter = "LowerLetter", + } + /** + * Represents the built-in style in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + * + * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. + */ + enum BuiltInStyleName { /** - * Represents a border with basic wide midline design. + * Mixed styles or other style not in this list. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basicWideMidline = "BasicWideMidline", + other = "Other", /** - * Represents a border with basic wide outline design. + * Reset character and paragraph style to default. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basicWideOutline = "BasicWideOutline", + normal = "Normal", /** - * Represents a border with basic wide inline design. + * Heading 1 style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basicWideInline = "BasicWideInline", + heading1 = "Heading1", /** - * Represents a border with basic thin lines design. + * Heading 2 style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basicThinLines = "BasicThinLines", + heading2 = "Heading2", /** - * Represents a border with basic white dashes design. + * Heading 3 style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basicWhiteDashes = "BasicWhiteDashes", + heading3 = "Heading3", /** - * Represents a border with basic white squares design. + * Heading 4 style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basicWhiteSquares = "BasicWhiteSquares", + heading4 = "Heading4", /** - * Represents a border with basic black squares design. + * Heading 5 style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basicBlackSquares = "BasicBlackSquares", + heading5 = "Heading5", /** - * Represents a border with basic black dashes design. + * Heading 6 style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basicBlackDashes = "BasicBlackDashes", + heading6 = "Heading6", /** - * Represents a border with basic black dots design. + * Heading 7 style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basicBlackDots = "BasicBlackDots", + heading7 = "Heading7", /** - * Represents a border with top stars design. + * Heading 8 style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - starsTop = "StarsTop", + heading8 = "Heading8", /** - * Represents a border with certificate banner design. + * Heading 9 style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - certificateBanner = "CertificateBanner", + heading9 = "Heading9", /** - * Represents a border with handmade design (variant 1). + * Table-of-content level 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - handmade1 = "Handmade1", + toc1 = "Toc1", /** - * Represents a border with handmade design (variant 2). + * Table-of-content level 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - handmade2 = "Handmade2", + toc2 = "Toc2", /** - * Represents a border with torn paper design. + * Table-of-content level 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - tornPaper = "TornPaper", + toc3 = "Toc3", /** - * Represents a border with black torn paper design. + * Table-of-content level 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - tornPaperBlack = "TornPaperBlack", + toc4 = "Toc4", /** - * Represents a border with coupon cutout dashes design. + * Table-of-content level 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - couponCutoutDashes = "CouponCutoutDashes", + toc5 = "Toc5", /** - * Represents a border with coupon cutout dots design. + * Table-of-content level 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - couponCutoutDots = "CouponCutoutDots", - } - /** - * Specifies the preferred unit of measure to use when measuring the width of an item. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum PreferredWidthType { + toc6 = "Toc6", /** - * Automatically select the unit of measure to use based on the current selection. + * Table-of-content level 7. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - auto = "Auto", + toc7 = "Toc7", /** - * Measure the current item width using a specified percentage. + * Table-of-content level 8. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - percent = "Percent", + toc8 = "Toc8", /** - * Measure the current item width using a specified number of points. + * Table-of-content level 9. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - points = "Points", - } - /** - * Specifies the way Word adjusts the table when the left indent is changed. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum RulerStyle { + toc9 = "Toc9", /** - * Adjusts the left edge of row or rows, preserving the width of all columns by shifting them to the left or right. This is the default value. + * Footnote text style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - none = "None", + footnoteText = "FootnoteText", /** - * Adjusts the left edge of the first column, preserving the position of the right edge of the table by proportionally adjusting the widths of all the cells in the specified row or rows. + * Header style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - proportional = "Proportional", + header = "Header", /** - * Adjusts the left edge of the first column only, preserving the positions of the other columns and the right edge of the table. + * Footer style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - firstColumn = "FirstColumn", + footer = "Footer", /** - * Adjusts the left edge of the first column, preserving the position of the right edge of the table by setting the widths of all the cells in the specified row or rows to the same value. + * Caption style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - sameWidth = "SameWidth", - } - /** - * Represents the East Asian language to use when breaking lines of text in the specified document or template. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum FarEastLineBreakLanguageId { + caption = "Caption", /** - * Represents Traditional Chinese language. + * Footnote reference style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - traditionalChinese = "TraditionalChinese", + footnoteReference = "FootnoteReference", /** - * Represents Japanese language. + * Endnote reference style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - japanese = "Japanese", + endnoteReference = "EndnoteReference", /** - * Represents Korean language. + * Endnote text style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - korean = "Korean", + endnoteText = "EndnoteText", /** - * Represents Simplified Chinese language. + * Title style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - simplifiedChinese = "SimplifiedChinese", - } - /** - * Represents the level of line breaking to use for East Asian languages in the specified document or template. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum FarEastLineBreakLevel { + title = "Title", /** - * Represents the normal line break level. + * Subtitle style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - normal = "Normal", + subtitle = "Subtitle", /** - * Represents the strict line break level. + * Hyperlink style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - strict = "Strict", + hyperlink = "Hyperlink", /** - * Represents the custom line break level. + * Strong style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - custom = "Custom", - } - /** - * Specifies the character spacing adjustment for a document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum JustificationMode { + strong = "Strong", /** - * Expands the character spacing + * Emphasis style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - expand = "Expand", + emphasis = "Emphasis", /** - * Compresses the character spacing. + * No spacing style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - compress = "Compress", + noSpacing = "NoSpacing", /** - * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. + * List paragraph style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - compressKana = "CompressKana", - } - /** - * Specifies the type of template. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum TemplateType { + listParagraph = "ListParagraph", /** - * Represents the normal template type. + * Quote style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - normal = "Normal", + quote = "Quote", /** - * Represents the global template type. + * Intense quote style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - global = "Global", + intenseQuote = "IntenseQuote", /** - * Represents the attached template type. + * Subtle emphasis style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - attached = "Attached", - } - /** - * Represents the language ID of a Word document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum LanguageId { + subtleEmphasis = "SubtleEmphasis", /** - * Afrikaans language. + * Intense emphasis style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - afrikaans = "Afrikaans", + intenseEmphasis = "IntenseEmphasis", /** - * Albanian language. + * Subtle reference style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - albanian = "Albanian", + subtleReference = "SubtleReference", /** - * Amharic language. + * Intense reference style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - amharic = "Amharic", + intenseReference = "IntenseReference", /** - * Arabic language. + * Book title style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabic = "Arabic", + bookTitle = "BookTitle", /** - * Arabic Algerian language. + * Bibliography style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicAlgeria = "ArabicAlgeria", + bibliography = "Bibliography", /** - * Arabic Bahraini language. + * Table-of-content heading. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicBahrain = "ArabicBahrain", + tocHeading = "TocHeading", /** - * Arabic Egyptian language. + * Table grid style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicEgypt = "ArabicEgypt", + tableGrid = "TableGrid", /** - * Arabic Iraqi language. + * Plain table style 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicIraq = "ArabicIraq", + plainTable1 = "PlainTable1", /** - * Arabic Jordanian language. + * Plain table style 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicJordan = "ArabicJordan", + plainTable2 = "PlainTable2", /** - * Arabic Kuwaiti language. + * Plain table style 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicKuwait = "ArabicKuwait", + plainTable3 = "PlainTable3", /** - * Arabic Lebanese language. + * Plain table style 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicLebanon = "ArabicLebanon", + plainTable4 = "PlainTable4", /** - * Arabic Libyan language. + * Plain table style 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicLibya = "ArabicLibya", + plainTable5 = "PlainTable5", /** - * Arabic Moroccan language. + * Table grid light style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicMorocco = "ArabicMorocco", + tableGridLight = "TableGridLight", /** - * Arabic Omani language. + * Grid table light style 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicOman = "ArabicOman", + gridTable1Light = "GridTable1Light", /** - * Arabic Qatari language. + * Grid table light style 1, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicQatar = "ArabicQatar", + gridTable1Light_Accent1 = "GridTable1Light_Accent1", /** - * Arabic Syrian language. + * Grid table light style 1, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicSyria = "ArabicSyria", + gridTable1Light_Accent2 = "GridTable1Light_Accent2", /** - * Arabic Tunisian language. + * Grid table light style 1, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicTunisia = "ArabicTunisia", + gridTable1Light_Accent3 = "GridTable1Light_Accent3", /** - * Arabic United Arab Emirates language. + * Grid table light style 1, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicUAE = "ArabicUAE", + gridTable1Light_Accent4 = "GridTable1Light_Accent4", /** - * Arabic Yemeni language. + * Grid table light style 1, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - arabicYemen = "ArabicYemen", + gridTable1Light_Accent5 = "GridTable1Light_Accent5", /** - * Armenian language. + * Grid table light style 1, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - armenian = "Armenian", + gridTable1Light_Accent6 = "GridTable1Light_Accent6", /** - * Assamese language. + * Grid table style 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - assamese = "Assamese", + gridTable2 = "GridTable2", /** - * Azerbaijani Cyrillic language. + * Grid table style 2, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - azeriCyrillic = "AzeriCyrillic", + gridTable2_Accent1 = "GridTable2_Accent1", /** - * Azerbaijani Latin language. + * Grid table style 2, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - azeriLatin = "AzeriLatin", + gridTable2_Accent2 = "GridTable2_Accent2", /** - * Basque (Basque). + * Grid table style 2, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - basque = "Basque", + gridTable2_Accent3 = "GridTable2_Accent3", /** - * Belgian Dutch language. + * Grid table style 2, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - belgianDutch = "BelgianDutch", + gridTable2_Accent4 = "GridTable2_Accent4", /** - * Belgian French language. + * Grid table style 2, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - belgianFrench = "BelgianFrench", + gridTable2_Accent5 = "GridTable2_Accent5", /** - * Bengali language. + * Grid table style 2, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - bengali = "Bengali", + gridTable2_Accent6 = "GridTable2_Accent6", /** - * Bulgarian language. + * Grid table style 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - bulgarian = "Bulgarian", + gridTable3 = "GridTable3", /** - * Burmese language. + * Grid table style 3, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - burmese = "Burmese", + gridTable3_Accent1 = "GridTable3_Accent1", /** - * Belarusian language. + * Grid table style 3, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - belarusian = "Belarusian", + gridTable3_Accent2 = "GridTable3_Accent2", /** - * Catalan language. + * Grid table style 3, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - catalan = "Catalan", + gridTable3_Accent3 = "GridTable3_Accent3", /** - * Cherokee language. + * Grid table style 3, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - cherokee = "Cherokee", + gridTable3_Accent4 = "GridTable3_Accent4", /** - * Chinese Hong Kong SAR language. + * Grid table style 3, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - chineseHongKongSAR = "ChineseHongKongSAR", + gridTable3_Accent5 = "GridTable3_Accent5", /** - * Chinese Macao SAR language. + * Grid table style 3, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - chineseMacaoSAR = "ChineseMacaoSAR", + gridTable3_Accent6 = "GridTable3_Accent6", /** - * Chinese Singapore language. + * Grid table style 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - chineseSingapore = "ChineseSingapore", + gridTable4 = "GridTable4", /** - * Croatian language. + * Grid table style 4, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - croatian = "Croatian", + gridTable4_Accent1 = "GridTable4_Accent1", /** - * Czech language. + * Grid table style 4, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - czech = "Czech", + gridTable4_Accent2 = "GridTable4_Accent2", /** - * Danish language. + * Grid table style 4, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - danish = "Danish", + gridTable4_Accent3 = "GridTable4_Accent3", /** - * Divehi language. + * Grid table style 4, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - divehi = "Divehi", + gridTable4_Accent4 = "GridTable4_Accent4", /** - * Dutch language. + * Grid table style 4, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - dutch = "Dutch", + gridTable4_Accent5 = "GridTable4_Accent5", /** - * Edo language. + * Grid table style 4, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - edo = "Edo", + gridTable4_Accent6 = "GridTable4_Accent6", /** - * Australian English language. + * Grid table dark style 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishAUS = "EnglishAUS", + gridTable5Dark = "GridTable5Dark", /** - * Belize English language. + * Grid table dark style 5, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishBelize = "EnglishBelize", + gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", /** - * Canadian English language. + * Grid table dark style 5, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishCanadian = "EnglishCanadian", + gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", /** - * Caribbean English language. + * Grid table dark style 5, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishCaribbean = "EnglishCaribbean", + gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", /** - * Indonesian English language. + * Grid table dark style 5, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishIndonesia = "EnglishIndonesia", + gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", /** - * Irish English language. + * Grid table dark style 5, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishIreland = "EnglishIreland", + gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", /** - * Jamaican English language. + * Grid table dark style 5, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishJamaica = "EnglishJamaica", + gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", /** - * New Zealand English language. + * Grid table colorful style 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishNewZealand = "EnglishNewZealand", + gridTable6Colorful = "GridTable6Colorful", /** - * Filipino English language. + * Grid table colorful style 6, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishPhilippines = "EnglishPhilippines", + gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", /** - * South African English language. + * Grid table colorful style 6, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishSouthAfrica = "EnglishSouthAfrica", + gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", /** - * Tobago Trinidad English language. + * Grid table colorful style 6, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishTrinidadTobago = "EnglishTrinidadTobago", + gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", /** - * United Kingdom English language. + * Grid table colorful style 6, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishUK = "EnglishUK", + gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", /** - * United States English language. + * Grid table colorful style 6, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishUS = "EnglishUS", + gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", /** - * Zimbabwe English language. + * Grid table colorful style 6, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - englishZimbabwe = "EnglishZimbabwe", + gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", /** - * Estonian language. + * Grid table colorful style 7. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - estonian = "Estonian", + gridTable7Colorful = "GridTable7Colorful", /** - * Faeroese language. + * Grid table colorful style 7, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - faeroese = "Faeroese", + gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", /** - * Filipino language. + * Grid table colorful style 7, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - filipino = "Filipino", + gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", /** - * Finnish language. + * Grid table colorful style 7, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - finnish = "Finnish", + gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", /** - * French language. + * Grid table colorful style 7, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - french = "French", + gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", /** - * French Cameroon language. + * Grid table colorful style 7, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchCameroon = "FrenchCameroon", + gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", /** - * French Canadian language. + * Grid table colorful style 7, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchCanadian = "FrenchCanadian", + gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", /** - * French (Congo (DRC)) language. + * List table light style 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchCongoDRC = "FrenchCongoDRC", + listTable1Light = "ListTable1Light", /** - * French Cote d'Ivoire language. + * List table light style 1, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchCotedIvoire = "FrenchCotedIvoire", + listTable1Light_Accent1 = "ListTable1Light_Accent1", /** - * French Haiti language. + * List table light style 1, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchHaiti = "FrenchHaiti", + listTable1Light_Accent2 = "ListTable1Light_Accent2", /** - * French Luxembourg language. + * List table light style 1, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchLuxembourg = "FrenchLuxembourg", + listTable1Light_Accent3 = "ListTable1Light_Accent3", /** - * French Mali language. + * List table light style 1, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchMali = "FrenchMali", + listTable1Light_Accent4 = "ListTable1Light_Accent4", /** - * French Monaco language. + * List table light style 1, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchMonaco = "FrenchMonaco", + listTable1Light_Accent5 = "ListTable1Light_Accent5", /** - * French Morocco language. + * List table light style 1, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchMorocco = "FrenchMorocco", + listTable1Light_Accent6 = "ListTable1Light_Accent6", /** - * French Reunion language. + * List table style 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchReunion = "FrenchReunion", + listTable2 = "ListTable2", /** - * French Senegal language. + * List table style 2, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchSenegal = "FrenchSenegal", + listTable2_Accent1 = "ListTable2_Accent1", /** - * French West Indies language. + * List table style 2, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frenchWestIndies = "FrenchWestIndies", + listTable2_Accent2 = "ListTable2_Accent2", /** - * Frisian Netherlands language. + * List table style 2, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - frisianNetherlands = "FrisianNetherlands", + listTable2_Accent3 = "ListTable2_Accent3", /** - * Fulfulde language. + * List table style 2, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - fulfulde = "Fulfulde", + listTable2_Accent4 = "ListTable2_Accent4", /** - * Irish (Irish) language. + * List table style 2, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - gaelicIreland = "GaelicIreland", + listTable2_Accent5 = "ListTable2_Accent5", /** - * Scottish Gaelic language. + * List table style 2, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - gaelicScotland = "GaelicScotland", + listTable2_Accent6 = "ListTable2_Accent6", /** - * Galician language. + * List table style 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - galician = "Galician", + listTable3 = "ListTable3", /** - * Georgian language. + * List table style 3, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - georgian = "Georgian", + listTable3_Accent1 = "ListTable3_Accent1", /** - * German language. + * List table style 3, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - german = "German", + listTable3_Accent2 = "ListTable3_Accent2", /** - * German Austrian language. + * List table style 3, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - germanAustria = "GermanAustria", + listTable3_Accent3 = "ListTable3_Accent3", /** - * German Liechtenstein language. + * List table style 3, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - germanLiechtenstein = "GermanLiechtenstein", + listTable3_Accent4 = "ListTable3_Accent4", /** - * German Luxembourg language. + * List table style 3, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - germanLuxembourg = "GermanLuxembourg", + listTable3_Accent5 = "ListTable3_Accent5", /** - * Greek language. + * List table style 3, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - greek = "Greek", + listTable3_Accent6 = "ListTable3_Accent6", /** - * Guarani language. + * List table style 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - guarani = "Guarani", + listTable4 = "ListTable4", /** - * Gujarati language. + * List table style 4, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - gujarati = "Gujarati", + listTable4_Accent1 = "ListTable4_Accent1", /** - * Hausa language. + * List table style 4, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - hausa = "Hausa", + listTable4_Accent2 = "ListTable4_Accent2", /** - * Hawaiian language. + * List table style 4, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - hawaiian = "Hawaiian", + listTable4_Accent3 = "ListTable4_Accent3", /** - * Hebrew language. + * List table style 4, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - hebrew = "Hebrew", + listTable4_Accent4 = "ListTable4_Accent4", /** - * Hindi language. + * List table style 4, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - hindi = "Hindi", + listTable4_Accent5 = "ListTable4_Accent5", /** - * Hungarian language. + * List table style 4, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - hungarian = "Hungarian", + listTable4_Accent6 = "ListTable4_Accent6", /** - * Ibibio language. + * List table dark style 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - ibibio = "Ibibio", + listTable5Dark = "ListTable5Dark", /** - * Icelandic language. + * List table dark style 5, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - icelandic = "Icelandic", + listTable5Dark_Accent1 = "ListTable5Dark_Accent1", /** - * Igbo language. + * List table dark style 5, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - igbo = "Igbo", + listTable5Dark_Accent2 = "ListTable5Dark_Accent2", /** - * Indonesian language. + * List table dark style 5, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - indonesian = "Indonesian", + listTable5Dark_Accent3 = "ListTable5Dark_Accent3", /** - * Inuktitut language. + * List table dark style 5, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - inuktitut = "Inuktitut", + listTable5Dark_Accent4 = "ListTable5Dark_Accent4", /** - * Italian language. + * List table dark style 5, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - italian = "Italian", + listTable5Dark_Accent5 = "ListTable5Dark_Accent5", /** - * Japanese language. + * List table dark style 5, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - japanese = "Japanese", + listTable5Dark_Accent6 = "ListTable5Dark_Accent6", /** - * Kannada language. + * List table colorful style 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - kannada = "Kannada", + listTable6Colorful = "ListTable6Colorful", /** - * Kanuri language. + * List table colorful style 6, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - kanuri = "Kanuri", + listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", /** - * Kashmiri language. + * List table colorful style 6, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - kashmiri = "Kashmiri", + listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", /** - * Kazakh language. + * List table colorful style 6, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - kazakh = "Kazakh", + listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", /** - * Khmer language. + * List table colorful style 6, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - khmer = "Khmer", + listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", /** - * Kirghiz language. + * List table colorful style 6, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - kirghiz = "Kirghiz", + listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", /** - * Konkani language. + * List table colorful style 6, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - konkani = "Konkani", + listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", /** - * Korean language. + * List table colorful style 7. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - korean = "Korean", + listTable7Colorful = "ListTable7Colorful", /** - * Kyrgyz language. + * List table colorful style 7, accent 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - kyrgyz = "Kyrgyz", + listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", /** - * No specified language. + * List table colorful style 7, accent 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - languageNone = "LanguageNone", + listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", /** - * Lao language. + * List table colorful style 7, accent 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - lao = "Lao", + listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", /** - * Latin language. + * List table colorful style 7, accent 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - latin = "Latin", + listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", /** - * Latvian language. + * List table colorful style 7, accent 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - latvian = "Latvian", + listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", /** - * Lithuanian language. + * List table colorful style 7, accent 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - lithuanian = "Lithuanian", + listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + } + /** + * Represents the document property type. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum DocumentPropertyType { /** - * Macedonian language. + * Represents a string type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - macedonianFYROM = "MacedonianFYROM", + string = "String", /** - * Malayalam language. + * Represents a number type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - malayalam = "Malayalam", + number = "Number", /** - * Malay Brunei Darussalam language. + * Represents a date type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - malayBruneiDarussalam = "MalayBruneiDarussalam", + date = "Date", /** - * Malaysian language. + * Represents a Boolean type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - malaysian = "Malaysian", + boolean = "Boolean", + } + /** + * Specifies the type of item to print from a document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum PrintOutItem { /** - * Maltese language. + * Represents printing the document content. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - maltese = "Maltese", + documentContent = "DocumentContent", /** - * Manipuri language. + * Represents printing the document properties. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - manipuri = "Manipuri", + properties = "Properties", /** - * Marathi language. + * Represents printing the comments. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - marathi = "Marathi", + comments = "Comments", /** - * Mexican Spanish language. + * Represents printing the markup. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - mexicanSpanish = "MexicanSpanish", + markup = "Markup", /** - * Mongolian language. + * Represents printing the styles. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - mongolian = "Mongolian", + styles = "Styles", /** - * Nepali language. + * Represents printing the AutoText entries. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nepali = "Nepali", + autoTextEntries = "AutoTextEntries", /** - * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. + * Represents printing the key assignments. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - noProofing = "NoProofing", + keyAssignments = "KeyAssignments", /** - * Norwegian Bokmol language. + * Represents printing the envelope. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - norwegianBokmol = "NorwegianBokmol", + envelope = "Envelope", /** - * Norwegian Nynorsk language. + * Represents printing the document with markup. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - norwegianNynorsk = "NorwegianNynorsk", + documentWithMarkup = "DocumentWithMarkup", + } + /** + * Specifies which pages to print based on odd or even page numbers. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum PrintOutPages { /** - * Odia (Oriya) language. + * Represents printing all pages. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - oriya = "Oriya", + all = "All", /** - * Oromo language. + * Represents printing only odd-numbered pages. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - oromo = "Oromo", + oddOnly = "OddOnly", /** - * Pashto language. + * Represents printing only even-numbered pages. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - pashto = "Pashto", + evenOnly = "EvenOnly", + } + /** + * Specifies the range of content to print from a document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum PrintOutRange { /** - * Persian language. + * Represents printing the entire document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - persian = "Persian", + allDocument = "AllDocument", /** - * Polish language. + * Represents printing the current selection. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - polish = "Polish", + selection = "Selection", /** - * Portuguese language. + * Represents printing the current page. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - portuguese = "Portuguese", + currentPage = "CurrentPage", /** - * Portuguese (Brazil) language. + * Represents printing a range from one page to another. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - portugueseBrazil = "PortugueseBrazil", + fromTo = "FromTo", /** - * Punjabi language. + * Represents printing specific ranges of pages. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - punjabi = "Punjabi", + rangeOfPages = "RangeOfPages", + } + /** + * Specifies the export format for a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ExportFormat { /** - * Rhaeto Romanic language. + * PDF export format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - rhaetoRomanic = "RhaetoRomanic", + pdf = "Pdf", /** - * Romanian language. + * XPS export format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - romanian = "Romanian", + xps = "Xps", + } + /** + * Specifies the export item type for a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ExportItem { /** - * Romanian Moldova language. + * Exports document content only. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - romanianMoldova = "RomanianMoldova", + documentContent = "DocumentContent", /** - * Russian language. + * Exports document with markup (annotations). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - russian = "Russian", + documentWithMarkup = "DocumentWithMarkup", + } + /** + * Specifies the optimization target for document export. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ExportOptimizeFor { /** - * Russian Moldova language. + * Optimizes for print. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - russianMoldova = "RussianMoldova", + print = "Print", /** - * Sami Lappish language. + * Optimizes for on-screen display. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - samiLappish = "SamiLappish", + onScreen = "OnScreen", + } + /** + * Specifies the range to export from a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ExportRange { /** - * Sanskrit language. + * Exports the entire document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sanskrit = "Sanskrit", + allDocument = "AllDocument", /** - * Serbian Cyrillic language. + * Exports the current selection. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - serbianCyrillic = "SerbianCyrillic", + selection = "Selection", /** - * Serbian Latin language. + * Exports the current page. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - serbianLatin = "SerbianLatin", + currentPage = "CurrentPage", /** - * Sesotho language. + * Exports a specific range of pages. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sesotho = "Sesotho", + fromTo = "FromTo", + } + /** + * Specifies the type of bookmarks to create during export. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ExportCreateBookmarks { /** - * Simplified Chinese language. + * Do not create bookmarks. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - simplifiedChinese = "SimplifiedChinese", + none = "None", /** - * Sindhi language. + * Creates bookmarks from headings. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sindhi = "Sindhi", + headings = "Headings", /** - * Sindhi (Pakistan) language. + * Creates bookmarks from Word bookmarks. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sindhiPakistan = "SindhiPakistan", + wordBookmarks = "WordBookmarks", + } + /** + * Specifies the source of formatting to use during document operations. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum UseFormattingFrom { /** - * Sinhalese language. + * Represents using formatting from the current document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sinhalese = "Sinhalese", + current = "Current", /** - * Slovakian language. + * Represents using formatting from the selected document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - slovak = "Slovak", + selected = "Selected", /** - * Slovenian language. + * Represents prompting the user for formatting preferences. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - slovenian = "Slovenian", + prompt = "Prompt", + } + /** + * Indicates the auto macros that can run automatically in Word. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum AutoMacro { /** - * Somali language. + * Indicates that the macro runs automatically when Word starts. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - somali = "Somali", + startWord = "StartWord", /** - * Sorbian language. + * Indicates that the macro runs automatically when a new document is created. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sorbian = "Sorbian", + new = "New", /** - * Spanish language. + * Indicates that the macro runs automatically when the document is opened. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanish = "Spanish", + open = "Open", /** - * Spanish Argentina language. + * Indicates that the macro runs automatically when the document is closed. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishArgentina = "SpanishArgentina", + close = "Close", /** - * Spanish Bolivian language. + * Indicates that the macro runs automatically when the document is saved. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishBolivia = "SpanishBolivia", + exit = "Exit", /** - * Spanish Chilean language. + * Indicates that the macro runs automatically when the document is synchronized. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishChile = "SpanishChile", + sync = "Sync", + } + /** + * Document statistic types. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum StatisticType { /** - * Spanish Colombian language. + * Words in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishColombia = "SpanishColombia", + words = "Words", /** - * Spanish Costa Rican language. + * Lines in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishCostaRica = "SpanishCostaRica", + lines = "Lines", /** - * Spanish Dominican Republic language. + * Pages in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishDominicanRepublic = "SpanishDominicanRepublic", + pages = "Pages", /** - * Spanish Ecuadorian language. + * Characters in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishEcuador = "SpanishEcuador", + characters = "Characters", /** - * Spanish El Salvadorian language. + * Paragraphs in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishElSalvador = "SpanishElSalvador", + paragraphs = "Paragraphs", /** - * Spanish Guatemala language. + * Characters including spaces. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishGuatemala = "SpanishGuatemala", + charactersWithSpaces = "CharactersWithSpaces", /** - * Spanish Honduran language. + * Far East (DBCS) characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishHonduras = "SpanishHonduras", + farEastCharacters = "FarEastCharacters", + } + /** + * Specifies the type of document information to remove. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum RemoveDocInfoType { /** - * Spanish Modern Sort language. + * Comments in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishModernSort = "SpanishModernSort", + comments = "Comments", /** - * Spanish Nicaraguan language. + * Revisions in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishNicaragua = "SpanishNicaragua", + revisions = "Revisions", /** - * Spanish Panamanian language. + * Versions in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishPanama = "SpanishPanama", + versions = "Versions", /** - * Spanish Paraguayan language. + * Personal information in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishParaguay = "SpanishParaguay", + removePersonalInformation = "RemovePersonalInformation", /** - * Spanish Peruvian language. + * Email header in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishPeru = "SpanishPeru", + emailHeader = "EmailHeader", /** - * Spanish Puerto Rican language. + * Routing slip in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishPuertoRico = "SpanishPuertoRico", + routingSlip = "RoutingSlip", /** - * Spanish Uruguayan language. + * Send for review information in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishUruguay = "SpanishUruguay", + sendForReview = "SendForReview", /** - * Spanish Venezuelan language. + * Document properties. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spanishVenezuela = "SpanishVenezuela", + documentProperties = "DocumentProperties", /** - * Sutu language. + * Template information. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sutu = "Sutu", + template = "Template", /** - * Swahili language. + * Document workspace properties. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - swahili = "Swahili", + documentWorkspace = "DocumentWorkspace", /** - * Swedish language. + * Ink annotations in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - swedish = "Swedish", + inkAnnotations = "InkAnnotations", /** - * Swedish Finnish language. + * Document server properties. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - swedishFinland = "SwedishFinland", + documentServerProperties = "DocumentServerProperties", /** - * Swiss French language. + * Document management policy. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - swissFrench = "SwissFrench", + documentManagementPolicy = "DocumentManagementPolicy", /** - * Swiss German language. + * Content type information. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - swissGerman = "SwissGerman", + contentType = "ContentType", /** - * Swiss Italian language. + * Taskpane web extensions. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - swissItalian = "SwissItalian", + taskpaneWebExtensions = "TaskpaneWebExtensions", /** - * Syriac language. + * At mentions in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - syriac = "Syriac", + atMentions = "AtMentions", /** - * Tajik language. + * Document tasks. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tajik = "Tajik", + documentTasks = "DocumentTasks", /** - * Tamazight language. + * Document intelligence information. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tamazight = "Tamazight", + documentIntelligence = "DocumentIntelligence", /** - * Tamazight Latin language. + * Comment reactions in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tamazightLatin = "TamazightLatin", + commentReactions = "CommentReactions", /** - * Tamil language. + * All document information types. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tamil = "Tamil", + all = "All", + } + /** + * Specifies the version type for document check-in operations. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum CheckInVersionType { /** - * Tatar language. + * Represents a minor version check-in. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tatar = "Tatar", + minor = "Minor", /** - * Telugu language. + * Represents a major version check-in. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - telugu = "Telugu", + major = "Major", /** - * Thai language. + * Represents an overwrite version check-in. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - thai = "Thai", + overwrite = "Overwrite", + } + /** + * Specifies the target document for merge operations. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum MergeTarget { /** - * Tibetan language. + * Represents merging into the selected document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tibetan = "Tibetan", + selected = "Selected", /** - * Tigrigna Eritrea language. + * Represents merging into the current document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tigrignaEritrea = "TigrignaEritrea", + current = "Current", /** - * Tigrigna Ethiopic language. + * Represents merging into a new document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tigrignaEthiopic = "TigrignaEthiopic", + new = "New", + } + /** + * Specifies the type of document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum DocumentType { /** - * Traditional Chinese language. + * Represents a standard document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - traditionalChinese = "TraditionalChinese", + document = "Document", /** - * Tsonga language. + * Represents a document template. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tsonga = "Tsonga", + template = "Template", /** - * Tswana language. + * Represents a frameset document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tswana = "Tswana", + frameset = "Frameset", + } + /** + * Specifies the kind or purpose of a document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum DocumentKind { /** - * Turkish language. + * Represents a document with no specified kind. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - turkish = "Turkish", + notSpecified = "NotSpecified", /** - * Turkmen language. + * Represents a letter document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - turkmen = "Turkmen", + letter = "Letter", /** - * Ukrainian language. + * Represents an email document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - ukrainian = "Ukrainian", + email = "Email", + } + /** + * Represents the file format to use when saving a document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum FileSaveFormat { /** - * Urdu language. + * Represents Microsoft Office Word 97 - 2003 binary file format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - urdu = "Urdu", + document = "Document", /** - * Uzbek Cyrillic language. + * Represents Word template format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - uzbekCyrillic = "UzbekCyrillic", + template = "Template", /** - * Uzbek Latin language. + * Represents Microsoft Windows text format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - uzbekLatin = "UzbekLatin", + text = "Text", /** - * Venda language. + * Represents Windows text format with line breaks preserved. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - venda = "Venda", + textLineBreaks = "TextLineBreaks", /** - * Vietnamese language. + * Represents Microsoft DOS text format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - vietnamese = "Vietnamese", + dosText = "DosText", /** - * Welsh language. + * Represents Microsoft DOS text with line breaks preserved. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - welsh = "Welsh", + dosTextLineBreaks = "DosTextLineBreaks", /** - * Xhosa language. + * Represents Rich Text Format (RTF). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - xhosa = "Xhosa", + rtf = "Rtf", /** - * Yi language. + * Represents Unicode text format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - yi = "Yi", + unicodeText = "UnicodeText", /** - * Yiddish language. + * Represents standard HTML format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - yiddish = "Yiddish", + html = "Html", /** - * Yoruba language. + * Represents Web archive format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - yoruba = "Yoruba", + webArchive = "WebArchive", /** - * Zulu language. + * Represents filtered HTML format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - zulu = "Zulu", - } - /** - * Specifies how a building block is inserted into a document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum DocPartInsertType { + filteredHtml = "FilteredHtml", /** - * Inserts the content of the building block. + * Represents Extensible Markup Language (XML) format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - content = "Content", + xml = "Xml", /** - * Inserts the building block as a paragraph. + * Represents XML document format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - paragraph = "Paragraph", + xmlDocument = "XmlDocument", /** - * Inserts the building block as a page. + * Represents XML document format with macros enabled. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - page = "Page", - } - /** - * Specifies the type of building block. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum BuildingBlockType { + xmlDocumentMacroEnabled = "XmlDocumentMacroEnabled", /** - * Represents Quick Parts building block type. + * Represents XML template format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - quickParts = "QuickParts", + xmlTemplate = "XmlTemplate", /** - * Represents Cover Page building block type. + * Represents XML template format with macros enabled. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - coverPage = "CoverPage", + xmlTemplateMacroEnabled = "XmlTemplateMacroEnabled", /** - * Represents Equations building block type. + * Represents Word default document file format. For Word, this is the DOCX format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - equations = "Equations", + documentDefault = "DocumentDefault", /** - * Represents Footers building block type. + * Represents PDF format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - footers = "Footers", + pdf = "Pdf", /** - * Represents Headers building block type. + * Represents XPS format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - headers = "Headers", + xps = "Xps", /** - * Represents Page Number building block type. + * Represents Open XML file format saved as a single XML file. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - pageNumber = "PageNumber", + flatXml = "FlatXml", /** - * Represents Tables building block type. + * Represents Open XML file format with macros enabled saved as a single XML file. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tables = "Tables", + flatXmlMacroEnabled = "FlatXmlMacroEnabled", /** - * Represents Watermarks building block type. + * Represents Open XML template format saved as a single XML file. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - watermarks = "Watermarks", + flatXmlTemplate = "FlatXmlTemplate", /** - * Represents AutoText building block type. + * Represents Open XML template format with macros enabled saved as a single XML file. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - autoText = "AutoText", + flatXmlTemplateMacroEnabled = "FlatXmlTemplateMacroEnabled", /** - * Represents Text Box building block type. + * Represents OpenDocument Text format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textBox = "TextBox", + openDocumentText = "OpenDocumentText", /** - * Represents Page Number Top building block type. + * Represents Strict Open XML document format. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - pageNumberTop = "PageNumberTop", + strictOpenXmlDocument = "StrictOpenXmlDocument", + } + /** + * Specifies the protection type for a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ProtectionType { /** - * Represents Page Number Bottom building block type. + * No protection is applied to the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - pageNumberBottom = "PageNumberBottom", + noProtection = "NoProtection", /** - * Represents Page Number Page building block type. + * Only revisions are allowed in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - pageNumberPage = "PageNumberPage", + allowOnlyRevisions = "AllowOnlyRevisions", /** - * Represents Table of Contents building block type. + * Only comments are allowed in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tableOfContents = "TableOfContents", + allowOnlyComments = "AllowOnlyComments", /** - * Represents Custom Quick Parts building block type. + * Only form fields are allowed in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customQuickParts = "CustomQuickParts", + allowOnlyFormFields = "AllowOnlyFormFields", /** - * Represents Custom Cover Page building block type. + * Only reading is allowed in the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customCoverPage = "CustomCoverPage", + allowOnlyReading = "AllowOnlyReading", + } + /** + * Represents how Word marks line and paragraph breaks in text files. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum LineEndingType { /** - * Represents Custom Equations building block type. + * Represents carriage return and line feed (Windows standard). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customEquations = "CustomEquations", + crlf = "Crlf", /** - * Represents Custom Footers building block type. + * Represents carriage return only (Mac classic standard). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customFooters = "CustomFooters", + crOnly = "CrOnly", /** - * Represents Custom Headers building block type. + * Represents line feed only (Unix/Linux standard). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customHeaders = "CustomHeaders", + lfOnly = "LfOnly", /** - * Represents Custom Page Number building block type. + * Represents line feed and carriage return. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customPageNumber = "CustomPageNumber", + lfcr = "Lfcr", /** - * Represents Custom Tables building block type. + * Represents line separator and paragraph separator. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customTables = "CustomTables", + lsps = "Lsps", + } + /** + * Specifies the document encoding types. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum DocumentEncoding { /** - * Represents Custom Watermarks building block type. + * Thai encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customWatermarks = "CustomWatermarks", + thai = "Thai", /** - * Represents Custom AutoText building block type. + * Japanese Shift Japanese Industrial Standards (Shift JIS) encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customAutoText = "CustomAutoText", + japaneseShiftJis = "JapaneseShiftJis", /** - * Represents Custom Text Box building block type. + * Simplified Chinese Guojia Biaozhun Kuozhan (GBK, which means "National Standard Extended" in Chinese) encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customTextBox = "CustomTextBox", + simplifiedChineseGbk = "SimplifiedChineseGbk", /** - * Represents Custom Page Number Top building block type. + * Korean encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customPageNumberTop = "CustomPageNumberTop", + korean = "Korean", /** - * Represents Custom Page Number Bottom building block type. + * Traditional Chinese Big5 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customPageNumberBottom = "CustomPageNumberBottom", + traditionalChineseBig5 = "TraditionalChineseBig5", /** - * Represents Custom Page Number Page building block type. + * Unicode Little Endian encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customPageNumberPage = "CustomPageNumberPage", + unicodeLittleEndian = "UnicodeLittleEndian", /** - * Represents Custom Table of Contents building block type. + * Unicode Big Endian encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customTableOfContents = "CustomTableOfContents", + unicodeBigEndian = "UnicodeBigEndian", /** - * Represents Custom building block type 1. + * Central European encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - custom1 = "Custom1", + centralEuropean = "CentralEuropean", /** - * Represents Custom building block type 2. + * Cyrillic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - custom2 = "Custom2", + cyrillic = "Cyrillic", /** - * Represents Custom building block type 3. + * Western encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - custom3 = "Custom3", + western = "Western", /** - * Represents Custom building block type 4. + * Greek encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - custom4 = "Custom4", + greek = "Greek", /** - * Represents Custom building block type 5. + * Turkish encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - custom5 = "Custom5", + turkish = "Turkish", /** - * Represents Bibliography building block type. + * Hebrew encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bibliography = "Bibliography", + hebrew = "Hebrew", /** - * Represents Custom Bibliography building block type. + * Arabic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customBibliography = "CustomBibliography", - } - /** - * Represents the type of a {@link Word.CustomXmlNode}. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum CustomXmlNodeType { + arabic = "Arabic", /** - * Represents an XML element node. + * Baltic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - element = "element", + baltic = "Baltic", /** - * Represents an XML attribute node. + * Vietnamese encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - attribute = "attribute", + vietnamese = "Vietnamese", /** - * Represents an XML text node. + * Auto detect encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - text = "text", + autoDetect = "AutoDetect", /** - * Represents an XML CDATA section node. + * Japanese auto detect encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - cData = "cData", + japaneseAutoDetect = "JapaneseAutoDetect", /** - * Represents an XML processing instruction node. + * Simplified Chinese auto detect encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - processingInstruction = "processingInstruction", + simplifiedChineseAutoDetect = "SimplifiedChineseAutoDetect", /** - * Represents an XML comment node. + * Korean auto detect encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - comment = "comment", + koreanAutoDetect = "KoreanAutoDetect", /** - * Represents an XML document node. + * Traditional Chinese auto detect encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - document = "document", - } - /** - * Represents the list formatting characteristics of a range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class ListFormat extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + traditionalChineseAutoDetect = "TraditionalChineseAutoDetect", /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * + * Cyrillic auto detect encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly list: Word.List; + cyrillicAutoDetect = "CyrillicAutoDetect", /** - * Gets the list template associated with the `ListFormat` object. - * + * Greek auto detect encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly listTemplate: Word.ListTemplate; + greekAutoDetect = "GreekAutoDetect", /** - * Indicates whether the `ListFormat` object contains a single list. - * + * Arabic auto detect encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly isSingleList: boolean; + arabicAutoDetect = "ArabicAutoDetect", /** - * Indicates whether the `ListFormat` object contains a single list template. - * + * ISO 8859-1 Latin1 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly isSingleListTemplate: boolean; + iso88591Latin1 = "Iso88591Latin1", /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. - * + * ISO 8859-2 Central Europe encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - listLevelNumber: number; + iso88592CentralEurope = "Iso88592CentralEurope", /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. - * + * ISO 8859-3 Latin3 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly listString: string; + iso88593Latin3 = "Iso88593Latin3", /** - * Gets the type of the list for the `ListFormat` object. - * + * ISO 8859-4 Baltic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + iso88594Baltic = "Iso88594Baltic", /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. - * + * ISO 8859-5 Cyrillic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly listValue: number; + iso88595Cyrillic = "Iso88595Cyrillic", /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * ISO 8859-6 Arabic encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListFormat): void; + iso88596Arabic = "Iso88596Arabic", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * ISO 8859-7 Greek encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `word97`. + * [Api set: WordApiDesktop 1.4] */ - applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; + iso88597Greek = "Iso88597Greek", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * ISO 8859-8 Hebrew encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `word97`. + * [Api set: WordApiDesktop 1.4] */ - applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + iso88598Hebrew = "Iso88598Hebrew", /** - * Applies a list template with a specific level to the paragraphs in the range. - * + * ISO 8859-9 Turkish encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param listTemplate The list template to apply. - * @param options Optional. Options for applying the list template, such as whether to continue the previous list or which part of the list to apply the template to. + * [Api set: WordApiDesktop 1.4] */ - applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; + iso88599Turkish = "Iso88599Turkish", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * ISO 8859-15 Latin9 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param defaultListBehavior Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.4] */ - applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + iso885915Latin9 = "Iso885915Latin9", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * ISO 8859-8 Hebrew logical encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param defaultListBehavior Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.4] */ - applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + iso88598HebrewLogical = "Iso88598HebrewLogical", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * ISO 2022-JP no halfwidth katakana encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param defaultListBehavior Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.4] */ - applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + iso2022JpNoHalfwidthKatakana = "Iso2022JpNoHalfwidthKatakana", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * ISO 2022-JP JIS X 0202-1984 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param defaultListBehavior Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.4] */ - applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + iso2022JpJisX02021984 = "Iso2022JpJisX02021984", /** - * Determines whether the `ListFormat` object can continue a previous list. - * + * ISO 2022-JP JIS X 0201-1989 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param listTemplate The list template to check. - * @returns A `Continue` value indicating whether continuation is possible. + * [Api set: WordApiDesktop 1.4] */ - canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; + iso2022JpJisX02011989 = "Iso2022JpJisX02011989", /** - * Converts numbers in the list to plain text. - * + * ISO 2022-KR encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param numberType Optional. The type of number to convert. + * [Api set: WordApiDesktop 1.4] */ - convertNumbersToText(numberType: Word.NumberType): void; + iso2022Kr = "Iso2022Kr", /** - * Converts numbers in the list to plain text. - * + * ISO 2022-CN Traditional Chinese encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param numberType Optional. The type of number to convert. + * [Api set: WordApiDesktop 1.4] */ - convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + iso2022CnTraditionalChinese = "Iso2022CnTraditionalChinese", /** - * Counts the numbered items in the list. - * + * ISO 2022-CN Simplified Chinese encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param options Optional. Options for counting numbered items, such as the type of number and the level to count. - * @returns The number of items. + * [Api set: WordApiDesktop 1.4] */ - countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; + iso2022CnSimplifiedChinese = "Iso2022CnSimplifiedChinese", /** - * Indents the list by one level. - * + * Mac Roman encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - listIndent(): void; + macRoman = "MacRoman", /** - * Outdents the list by one level. - * + * Mac Japanese encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - listOutdent(): void; + macJapanese = "MacJapanese", /** - * Removes numbering from the list. - * + * Mac Traditional Chinese Big5 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param numberType Optional. The type of number to remove. + * [Api set: WordApiDesktop 1.4] */ - removeNumbers(numberType: Word.NumberType): void; + macTraditionalChineseBig5 = "MacTraditionalChineseBig5", /** - * Removes numbering from the list. - * + * Mac Korean encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param numberType Optional. The type of number to remove. + * [Api set: WordApiDesktop 1.4] */ - removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + macKorean = "MacKorean", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Mac Arabic encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; + macArabic = "MacArabic", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Mac Hebrew encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.ListFormat; + macHebrew = "MacHebrew", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Mac Greek1 encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ListFormat; + macGreek1 = "MacGreek1", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Mac Cyrillic encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.ListFormat; + macCyrillic = "MacCyrillic", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Mac Simplified Chinese GB2312 encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.ListFormat; - /** - * 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.ListFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.ListFormatData; - } - /** - * Represents options for counting numbered items in a range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface ListFormatCountNumberedItemsOptions { + macSimplifiedChineseGb2312 = "MacSimplifiedChineseGb2312", /** - * If provided, specifies the level to count. The default value is 1. - * + * Mac Romania encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - level?: number; + macRomania = "MacRomania", /** - * If provided, specifies the type of number to count. The default value is `paragraph`. - * + * Mac Ukraine encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; - } - /** - * Represents options for applying a list template to a range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface ListTemplateApplyOptions { + macUkraine = "MacUkraine", /** - * If provided, specifies the level to apply in the list template. The default value is 1. - * + * Mac Latin2 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - applyLevel?: number; + macLatin2 = "MacLatin2", /** - * If provided, specifies which part of the list to apply the template to. The default value is `wholeList`. - * + * Mac Icelandic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; + macIcelandic = "MacIcelandic", /** - * If provided, specifies whether to continue the previous list. The default value is `false`. - * + * Mac Turkish encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - continuePreviousList?: boolean; + macTurkish = "MacTurkish", /** - * If provided, specifies the default list behavior. The default value is `word97`. - * + * Mac Croatia encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - defaultListBehavior?: Word.DefaultListBehavior | "Word97" | "Word2000" | "Word2002"; - } - /** - * Represents the fill formatting for a shape or text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class FillFormat extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + macCroatia = "MacCroatia", /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * + * EBCDIC US-Canada encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly backgroundColor: Word.ColorFormat; + ebcdicUsCanada = "EbcdicUsCanada", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * + * EBCDIC International encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly foregroundColor: Word.ColorFormat; + ebcdicInternational = "EbcdicInternational", /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. - * + * EBCDIC Multilingual ROECE Latin2 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - gradientAngle: number; + ebcdicMultilingualRoeceLatin2 = "EbcdicMultilingualRoeceLatin2", /** - * Gets the gradient color type. - * + * EBCDIC Greek Modern encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + ebcdicGreekModern = "EbcdicGreekModern", /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. - * + * EBCDIC Turkish Latin5 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly gradientDegree: number; + ebcdicTurkishLatin5 = "EbcdicTurkishLatin5", /** - * Returns the gradient style for the fill. - * + * EBCDIC Germany encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + ebcdicGermany = "EbcdicGermany", /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. - * + * EBCDIC Denmark-Norway encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly gradientVariant: number; + ebcdicDenmarkNorway = "EbcdicDenmarkNorway", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * EBCDIC Finland-Sweden encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isVisible: boolean; + ebcdicFinlandSweden = "EbcdicFinlandSweden", /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. - * + * EBCDIC Italy encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + ebcdicItaly = "EbcdicItaly", /** - * Returns the preset gradient type for the fill. - * + * EBCDIC Latin America-Spain encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + ebcdicLatinAmericaSpain = "EbcdicLatinAmericaSpain", /** - * Gets the preset texture. - * + * EBCDIC United Kingdom encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + ebcdicUnitedKingdom = "EbcdicUnitedKingdom", /** - * Specifies whether the fill rotates with the shape. - * + * EBCDIC Japanese Katakana Extended encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - rotateWithObject: boolean; + ebcdicJapaneseKatakanaExtended = "EbcdicJapaneseKatakanaExtended", /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. - * + * EBCDIC France encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + ebcdicFrance = "EbcdicFrance", /** - * Specifies the horizontal scaling factor for the texture fill. - * + * EBCDIC Arabic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureHorizontalScale: number; + ebcdicArabic = "EbcdicArabic", /** - * Returns the name of the custom texture file for the fill. - * + * EBCDIC Greek encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly textureName: string; + ebcdicGreek = "EbcdicGreek", /** - * Specifies the horizontal offset of the texture from the origin in points. - * + * EBCDIC Hebrew encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureOffsetX: number; + ebcdicHebrew = "EbcdicHebrew", /** - * Specifies the vertical offset of the texture. - * + * EBCDIC Korean Extended encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureOffsetY: number; + ebcdicKoreanExtended = "EbcdicKoreanExtended", /** - * Specifies whether the texture is tiled. - * + * EBCDIC Thai encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureTile: boolean; + ebcdicThai = "EbcdicThai", /** - * Returns the texture type for the fill. - * + * EBCDIC Icelandic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + ebcdicIcelandic = "EbcdicIcelandic", /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. - * + * EBCDIC Turkish encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureVerticalScale: number; + ebcdicTurkish = "EbcdicTurkish", /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). - * + * EBCDIC Russian encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - transparency: number; + ebcdicRussian = "EbcdicRussian", /** - * Gets the fill format type. - * + * EBCDIC Serbian-Bulgarian encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + ebcdicSerbianBulgarian = "EbcdicSerbianBulgarian", /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * EBCDIC Japanese Katakana Extended and Japanese encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.FillFormat): void; + ebcdicJapaneseKatakanaExtendedAndJapanese = "EbcdicJapaneseKatakanaExtendedAndJapanese", /** - * Sets the fill to a one-color gradient. - * + * EBCDIC US-Canada and Japanese encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param style The gradient style. - * @param variant The gradient variant. Can be a value from 1 to 4. - * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). + * [Api set: WordApiDesktop 1.4] */ - setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; + ebcdicUsCanadaAndJapanese = "EbcdicUsCanadaAndJapanese", /** - * Sets the fill to a one-color gradient. - * + * EBCDIC Korean Extended and Korean encoding. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param style The gradient style. - * @param variant The gradient variant. Can be a value from 1 to 4. - * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). + * [Api set: WordApiDesktop 1.4] */ - setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; + ebcdicKoreanExtendedAndKorean = "EbcdicKoreanExtendedAndKorean", /** - * Sets the fill to a pattern. - * + * EBCDIC Simplified Chinese Extended and Simplified Chinese encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - setPatterned(pattern: Word.PatternType): void; + ebcdicSimplifiedChineseExtendedAndSimplifiedChinese = "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese", /** - * Sets the fill to a pattern. - * + * EBCDIC US-Canada and Traditional Chinese encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void; + ebcdicUsCanadaAndTraditionalChinese = "EbcdicUsCanadaAndTraditionalChinese", /** - * Sets the fill to a preset gradient. - The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. - * + * EBCDIC Japanese Latin Extended and Japanese encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; + ebcdicJapaneseLatinExtendedAndJapanese = "EbcdicJapaneseLatinExtendedAndJapanese", /** - * Sets the fill to a preset gradient. - The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. - * + * OEM United States encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void; + oemUnitedStates = "OemUnitedStates", /** - * Sets the fill to a preset texture. - * + * OEM Greek 437G encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - setPresetTextured(presetTexture: Word.PresetTexture): void; + oemGreek437G = "OemGreek437G", /** - * Sets the fill to a preset texture. - * + * OEM Baltic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void; + oemBaltic = "OemBaltic", /** - * Sets the fill to a two-color gradient. - * + * OEM Multilingual Latin I encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - setTwoColorGradient(style: Word.GradientStyle, variant: number): void; + oemMultilingualLatinI = "OemMultilingualLatinI", /** - * Sets the fill to a two-color gradient. - * + * OEM Multilingual Latin II encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; + oemMultilingualLatinIi = "OemMultilingualLatinIi", /** - * Sets the fill to a uniform color. - * + * OEM Cyrillic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - solid(): void; + oemCyrillic = "OemCyrillic", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * OEM Turkish encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat; + oemTurkish = "OemTurkish", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * OEM Portuguese encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.FillFormat; + oemPortuguese = "OemPortuguese", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * OEM Icelandic encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.FillFormat; + oemIcelandic = "OemIcelandic", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * OEM Hebrew encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.FillFormat; + oemHebrew = "OemHebrew", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * OEM Canadian French encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.FillFormat; - /** - * 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.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.FillFormatData; - } - /** - * Represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class GlowFormat extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + oemCanadianFrench = "OemCanadianFrench", /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * + * OEM Arabic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly color: Word.ColorFormat; + oemArabic = "OemArabic", /** - * Specifies the length of the radius for a glow effect. - * + * OEM Nordic encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - radius: number; + oemNordic = "OemNordic", /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * OEM Cyrillic II encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - transparency: number; + oemCyrillicIi = "OemCyrillicIi", /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * OEM Modern Greek encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.GlowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.GlowFormat): void; + oemModernGreek = "OemModernGreek", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * EUC Japanese encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; + eucJapanese = "EucJapanese", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * EUC Chinese Simplified Chinese encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.GlowFormat; + eucChineseSimplifiedChinese = "EucChineseSimplifiedChinese", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * EUC Korean encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.GlowFormat; + eucKorean = "EucKorean", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * EUC Taiwanese Traditional Chinese encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.GlowFormat; + eucTaiwaneseTraditionalChinese = "EucTaiwaneseTraditionalChinese", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * ISCII Devanagari encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.GlowFormat; - /** - * 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.GlowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GlowFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.GlowFormatData; - } - /** - * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; - for a shape with a border, this object contains formatting information for the shape's border. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class LineFormat extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + isciiDevanagari = "IsciiDevanagari", /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * + * ISCII Bengali encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly backgroundColor: Word.ColorFormat; + isciiBengali = "IsciiBengali", /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * + * ISCII Tamil encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - readonly foregroundColor: Word.ColorFormat; + isciiTamil = "IsciiTamil", /** - * Specifies the length of the arrowhead at the beginning of the line. - * + * ISCII Telugu encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + isciiTelugu = "IsciiTelugu", /** - * Specifies the style of the arrowhead at the beginning of the line. - * + * ISCII Assamese encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + isciiAssamese = "IsciiAssamese", /** - * Specifies the width of the arrowhead at the beginning of the line. - * + * ISCII Oriya encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + isciiOriya = "IsciiOriya", /** - * Specifies the dash style for the line. - * + * ISCII Kannada encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + isciiKannada = "IsciiKannada", /** - * Specifies the length of the arrowhead at the end of the line. - * + * ISCII Malayalam encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + isciiMalayalam = "IsciiMalayalam", /** - * Specifies the style of the arrowhead at the end of the line. - * + * ISCII Gujarati encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + isciiGujarati = "IsciiGujarati", /** - * Specifies the width of the arrowhead at the end of the line. - * + * ISCII Punjabi encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + isciiPunjabi = "IsciiPunjabi", /** - * Specifies if to draw lines inside a shape. - * + * Arabic ASMO encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - insetPen: boolean; + arabicAsmo = "ArabicAsmo", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Arabic Transparent ASMO encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isVisible: boolean; + arabicTransparentAsmo = "ArabicTransparentAsmo", /** - * Specifies the pattern applied to the line. - * + * Korean Johab encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + koreanJohab = "KoreanJohab", /** - * Specifies the line format style. - * + * Taiwan CNS encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + taiwanCns = "TaiwanCns", /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). - * + * Taiwan TCA encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - transparency: number; + taiwanTca = "TaiwanTca", /** - * Specifies the thickness of the line in points. - * + * Taiwan Eten encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - weight: number; + taiwanEten = "TaiwanEten", /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Taiwan IBM5550 encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LineFormat): void; + taiwanIbm5550 = "TaiwanIbm5550", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Taiwan TeleText encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; + taiwanTeleText = "TaiwanTeleText", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Taiwan Wang encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.LineFormat; + taiwanWang = "TaiwanWang", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * IA5 IRV encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.LineFormat; + ia5Irv = "Ia5Irv", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * IA5 German encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.LineFormat; + ia5German = "Ia5German", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * IA5 Swedish encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.LineFormat; - /** - * 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.LineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.LineFormatData; - } - /** - * Represents the reflection formatting for a shape in Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class ReflectionFormat extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + ia5Swedish = "Ia5Swedish", /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. - * + * IA5 Norwegian encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - blur: number; + ia5Norwegian = "Ia5Norwegian", /** - * Specifies the amount of separation, in points, of the reflected image from the shape. - * + * US ASCII encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - offset: number; + usaAscii = "UsaAscii", /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. - * + * T61 encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - size: number; + t61 = "T61", /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * ISO 6937 Non-Spacing Accent encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - transparency: number; + iso6937NonSpacingAccent = "Iso6937NonSpacingAccent", /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. - * + * KOI8-R encoding. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + koi8R = "Koi8R", /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Ext Alpha Lowercase encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - set(properties: Interfaces.ReflectionFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ReflectionFormat): void; + extAlphaLowercase = "ExtAlphaLowercase", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * KOI8-U encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; + koi8U = "Koi8U", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Europa3 encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNames?: string | string[]): Word.ReflectionFormat; + europa3 = "Europa3", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * HZ GB Simplified Chinese encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ReflectionFormat; + hzGbSimplifiedChinese = "HzGbSimplifiedChinese", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Simplified Chinese GB18030 encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - track(): Word.ReflectionFormat; + simplifiedChineseGb18030 = "SimplifiedChineseGb18030", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * UTF-7 encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - untrack(): Word.ReflectionFormat; + utf7 = "Utf7", /** - * 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.ReflectionFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReflectionFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.ReflectionFormatData; + * UTF-8 encoding. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + utf8 = "Utf8", } /** - * Represents the color formatting of a shape or text in Word. + * Specifies the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - class ColorFormat extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + enum CompatibilityMode { /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Word 2003 compatibility mode. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - brightness: number; + word2003 = "Word2003", /** - * Specifies the theme color for a color format. - * + * Word 2007 compatibility mode. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + word2007 = "Word2007", /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. - * + * Word 2010 compatibility mode. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - rgb: string; + word2010 = "Word2010", /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Word 2013 compatibility mode. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tintAndShade: number; + word2013 = "Word2013", /** - * Returns the shape color type. - * + * Current Word version compatibility mode. * @remarks - * [Api set: WordApiDesktop 1.3] - */ - readonly type: Word.ColorType | "rgb" | "scheme"; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.ColorFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ColorFormat): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * [Api set: WordApiDesktop 1.4] */ - load(options?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; + current = "Current", + } + /** + * Represents the type of style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum StyleType { /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Represents that the style is a character style. + * @remarks + * [Api set: WordApi 1.5] */ - load(propertyNames?: string | string[]): Word.ColorFormat; + character = "Character", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Represents that the style is a list style. Currently supported on desktop. + * @remarks + * [Api set: WordApi 1.5] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ColorFormat; + list = "List", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents that the style is a paragraph style. + * @remarks + * [Api set: WordApi 1.5] */ - track(): Word.ColorFormat; + paragraph = "Paragraph", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents that the style is a table style. + * @remarks + * [Api set: WordApi 1.5] */ - untrack(): Word.ColorFormat; - /** - * 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.ColorFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ColorFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.ColorFormatData; + table = "Table", } /** - * Represents the shadow formatting for a shape or text in Word. + * Represents the outline levels. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - class ShadowFormat extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + enum OutlineLevel { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * + * Represents outline level 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - readonly foregroundColor: Word.ColorFormat; + outlineLevel1 = "OutlineLevel1", /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. - * + * Represents outline level 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - blur: number; + outlineLevel2 = "OutlineLevel2", /** - * Specifies whether the object or the formatting applied to it is visible. - * + * Represents outline level 3. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - isVisible: boolean; + outlineLevel3 = "OutlineLevel3", /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. - * + * Represents outline level 4. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - obscured: boolean; + outlineLevel4 = "OutlineLevel4", /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. - * + * Represents outline level 5. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - offsetX: number; + outlineLevel5 = "OutlineLevel5", /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. - * + * Represents outline level 6. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - offsetY: number; + outlineLevel6 = "OutlineLevel6", /** - * Specifies whether to rotate the shadow when rotating the shape. - * + * Represents outline level 7. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - rotateWithShape: boolean; + outlineLevel7 = "OutlineLevel7", /** - * Specifies the width of the shadow. - * + * Represents outline level 8. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - size: number; + outlineLevel8 = "OutlineLevel8", /** - * Specifies the type of shadow formatting to apply to a shape. - * + * Represents outline level 9. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + outlineLevel9 = "OutlineLevel9", /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). - * + * Represents outline level body text, not an outline level. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - transparency: number; + outlineLevelBodyText = "OutlineLevelBodyText", + } + /** + * Specifies the close behavior for `Document.close`. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum CloseBehavior { /** - * Specifies the shape shadow type. - * + * Saves the changes before closing the document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + save = "Save", /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Discard the possible changes when closing the document. + * @remarks + * [Api set: WordApi 1.5] */ - set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShadowFormat): void; + skipSave = "SkipSave", + } + /** + * Specifies the save behavior for `Document.save`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SaveBehavior { /** - * Changes the horizontal offset of the shadow by the number of points. - Increment The number of points to adjust. - * + * Saves the document without prompting the user. If it's a new document, + it will be saved with the default name or specified name in the default location. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - incrementOffsetX(increment: number): void; + save = "Save", /** - * Changes the vertical offset of the shadow by the specified number of points. - Increment The number of points to adjust. - * + * Displays the "Save As" dialog to the user if the document hasn't been saved. + Won't take effect if the document was previously saved. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - incrementOffsetY(increment: number): void; + prompt = "Prompt", + } + /** + * Represents the type of {@link Word.Field} object. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldType { /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents that the field type is Add-in. + * @remarks + * [Api set: WordApi 1.5] */ - load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat; + addin = "Addin", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Represents that the field type is AddressBlock. + * @remarks + * [Api set: WordApi 1.5] */ - load(propertyNames?: string | string[]): Word.ShadowFormat; + addressBlock = "AddressBlock", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Represents that the field type is Advance. + * @remarks + * [Api set: WordApi 1.5] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShadowFormat; + advance = "Advance", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents that the field type is Ask. + * @remarks + * [Api set: WordApi 1.5] */ - track(): Word.ShadowFormat; + ask = "Ask", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents that the field type is Author. + * @remarks + * [Api set: WordApi 1.5] */ - untrack(): Word.ShadowFormat; - /** - * 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.ShadowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadowFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.ShadowFormatData; - } - /** - * Represents a shape's three-dimensional formatting. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class ThreeDimensionalFormat extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + author = "Author", /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * + * Represents that the field type is AutoText. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - readonly contourColor: Word.ColorFormat; + autoText = "AutoText", /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * + * Represents that the field type is AutoTextList. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - readonly extrusionColor: Word.ColorFormat; + autoTextList = "AutoTextList", /** - * Specifies the depth of the bottom bevel. - * + * Represents that the field type is Barcode. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - bevelBottomDepth: number; + barCode = "BarCode", /** - * Specifies the inset size for the bottom bevel. - * + * Represents that the field type is Bibliography. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - bevelBottomInset: number; + bibliography = "Bibliography", /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. - * + * Represents that the field type is BidiOutline. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + bidiOutline = "BidiOutline", /** - * Specifies the depth of the top bevel. - * + * Represents that the field type is Citation. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - bevelTopDepth: number; + citation = "Citation", /** - * Specifies the inset size for the top bevel. - * + * Represents that the field type is Comments. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - bevelTopInset: number; + comments = "Comments", /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. - * + * Represents that the field type is Compare. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + compare = "Compare", /** - * Specifies the width of the contour of a shape. - * + * Represents that the field type is CreateDate. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - contourWidth: number; + createDate = "CreateDate", /** - * Specifies the depth of the shape's extrusion. - * + * Represents that the field type is Data. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - depth: number; + data = "Data", /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. - * + * Represents that the field type is Database. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + database = "Database", /** - * Specifies the amount of perspective for a shape. - * + * Represents that the field type is Date. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - fieldOfView: number; + date = "Date", /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. - * + * Represents that the field type is DisplayBarcode. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - isPerspective: boolean; + displayBarcode = "DisplayBarcode", /** - * Specifies if the specified object, or the formatting applied to it, is visible. - * + * Represents that the field type is DocumentProperty * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - isVisible: boolean; + docProperty = "DocProperty", /** - * Specifies the angle of the lighting. - * + * Represents that the field type is DocumentVariable. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - lightAngle: number; + docVariable = "DocVariable", /** - * Returns a `PresetCamera` value that represents the camera presets. - * + * Represents that the field type is EditTime. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + editTime = "EditTime", /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). - * + * Represents that the field type is Embedded. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + embedded = "Embedded", /** - * Specifies a `LightRigType` value that represents the lighting preset. - * + * Represents that the field type is Equation. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + eq = "EQ", /** - * Specifies the position of the light source relative to the extrusion. - * + * Represents that the field type is Expression. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + expression = "Expression", /** - * Specifies the intensity of the extrusion lighting. - * + * Represents that the field type is FileName. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + fileName = "FileName", /** - * Specifies the extrusion surface material. - * + * Represents that the field type is FileSize. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + fileSize = "FileSize", /** - * Returns the preset extrusion format. - * + * Represents that the field type is FillIn. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + fillIn = "FillIn", /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. - * + * Represents that the field type is FormCheckbox. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - projectText: boolean; + formCheckbox = "FormCheckbox", /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. - * + * Represents that the field type is FormDropdown. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - rotationX: number; + formDropdown = "FormDropdown", /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. - * + * Represents that the field type is FormText. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - rotationY: number; + formText = "FormText", /** - * Specifies the z-axis rotation of the camera. - * + * Represents that the field type is GotoButton. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - rotationZ: number; + gotoButton = "GotoButton", /** - * Specifies the position on the z-axis for the shape. - * + * Represents that the field type is GreetingLine. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - z: number; + greetingLine = "GreetingLine", /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents that the field type is Hyperlink. + * @remarks + * [Api set: WordApi 1.5] */ - set(properties: Interfaces.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ThreeDimensionalFormat): void; + hyperlink = "Hyperlink", /** - * Horizontally rotates a shape on the x-axis. - The number of degrees to rotate. - * + * Represents that the field type is If. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - incrementRotationHorizontal(increment: number): void; + if = "If", /** - * Vertically rotates a shape on the y-axis. - The number of degrees to rotate. - * + * Represents that the field type is Import. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - incrementRotationVertical(increment: number): void; + import = "Import", /** - * Changes the rotation around the x-axis. - The number of degrees to rotate. - * + * Represents that the field type is Include. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - incrementRotationX(increment: number): void; + include = "Include", /** - * Changes the rotation around the y-axis. - The number of degrees to rotate. - * + * Represents that the field type is IncludePicture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - incrementRotationY(increment: number): void; + includePicture = "IncludePicture", /** - * Rotates a shape on the z-axis. - The number of degrees to rotate. - * + * Represents that the field type is IncludeText. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - incrementRotationZ(increment: number): void; + includeText = "IncludeText", /** - * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. - * + * Represents that the field type is Index. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - resetRotation(): void; + index = "Index", /** - * Sets the direction of the extrusion's sweep path. - * + * Represents that the field type is Information. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param presetExtrusionDirection The preset direction. + * [Api set: WordApi 1.5] */ - setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; + info = "Info", /** - * Sets the direction of the extrusion's sweep path. - * + * Represents that the field type is Keywords. * @remarks - * [Api set: WordApiDesktop 1.3] - * - * @param presetExtrusionDirection The preset direction. + * [Api set: WordApi 1.5] */ - setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; + keywords = "Keywords", /** - * Sets the camera preset for the shape. - The preset camera type. - * + * Represents that the field type is LastSavedBy. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - setPresetCamera(presetCamera: Word.PresetCamera): void; + lastSavedBy = "LastSavedBy", /** - * Sets the camera preset for the shape. - The preset camera type. - * + * Represents that the field type is Link. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void; + link = "Link", /** - * Sets the preset extrusion format. - The preset format. - * + * Represents that the field type is ListNumber. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; + listNum = "ListNum", /** - * Sets the preset extrusion format. - The preset format. - * + * Represents that the field type is MacroButton. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): void; + macroButton = "MacroButton", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents that the field type is MergeBarcode. + * @remarks + * [Api set: WordApi 1.5] */ - load(options?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; + mergeBarcode = "MergeBarcode", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Represents that the field type is MergeField. + * @remarks + * [Api set: WordApi 1.5] */ - load(propertyNames?: string | string[]): Word.ThreeDimensionalFormat; + mergeField = "MergeField", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Represents that the field type is MergeRecord. + * @remarks + * [Api set: WordApi 1.5] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ThreeDimensionalFormat; + mergeRec = "MergeRec", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents that the field type is MergeSequence. + * @remarks + * [Api set: WordApi 1.5] */ - track(): Word.ThreeDimensionalFormat; + mergeSeq = "MergeSeq", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents that the field type is Next. + * @remarks + * [Api set: WordApi 1.5] */ - untrack(): Word.ThreeDimensionalFormat; - /** - * 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.ThreeDimensionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ThreeDimensionalFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.ThreeDimensionalFormatData; - } - /** - * Specifies the length of the arrowhead at the end of a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum ArrowheadLength { + next = "Next", /** - * Represents a mixed arrowhead length. + * Represents that the field type is NextIf. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - mixed = "Mixed", + nextIf = "NextIf", /** - * Represents a short arrowhead length. + * Represents that the field type is NoteReference. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - short = "Short", + noteRef = "NoteRef", /** - * Represents a medium arrowhead length. + * Represents that the field type is NumberOfCharacters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - medium = "Medium", + numChars = "NumChars", /** - * Represents a long arrowhead length. + * Represents that the field type is NumberOfPages. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - long = "Long", - } - /** - * Specifies the style of the arrowhead at the end of a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum ArrowheadStyle { + numPages = "NumPages", /** - * Represents a mixed arrowhead style. + * Represents that the field type is NumberOfWords. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - mixed = "Mixed", + numWords = "NumWords", /** - * Represents no arrowhead. + * Represents that the field type is ActiveXControl. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - none = "None", + ocx = "OCX", /** - * Represents a triangle arrowhead style. + * Represents that the field type is Page. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - triangle = "Triangle", + page = "Page", /** - * Represents an open arrowhead style. + * Represents that the field type is PageReference. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - open = "Open", + pageRef = "PageRef", /** - * Represents a stealth arrowhead style. + * Represents that the field type is Print. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - stealth = "Stealth", + print = "Print", /** - * Represents a diamond arrowhead style. + * Represents that the field type is PrintDate. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - diamond = "Diamond", + printDate = "PrintDate", /** - * Represents an oval arrowhead style. + * Represents that the field type is Private. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - oval = "Oval", - } - /** - * Specifies the width of the arrowhead at the end of a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum ArrowheadWidth { + private = "Private", /** - * Represents a mixed arrowhead width. + * Represents that the field type is Quote. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - mixed = "Mixed", + quote = "Quote", /** - * Represents a narrow arrowhead width. + * Represents that the field type is ReferencedDocument. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - narrow = "Narrow", + rd = "RD", /** - * Represents a medium arrowhead width. + * Represents that the field type is Reference. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - medium = "Medium", + ref = "Ref", /** - * Represents a wide arrowhead width. + * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - wide = "Wide", - } - /** - * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum BevelType { + revNum = "RevNum", /** - * Represents a mixed bevel type. + * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - mixed = "mixed", + saveDate = "SaveDate", /** - * Represents no bevel. + * Represents that the field type is Section. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - none = "none", + section = "Section", /** - * Represents a relaxed inset bevel. + * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - relaxedInset = "relaxedInset", + sectionPages = "SectionPages", /** - * Represents a circle bevel. + * Represents that the field type is Sequence. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - circle = "circle", + seq = "Seq", /** - * Represents a slope bevel. - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - slope = "slope", - /** - * Represents a cross bevel. - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - cross = "cross", - /** - * Represents an angle bevel. + * Represents that the field type is Set. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - angle = "angle", + set = "Set", /** - * Represents a soft round bevel. + * Represents that the field type is Shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - softRound = "softRound", + shape = "Shape", /** - * Represents a convex bevel. + * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - convex = "convex", + skipIf = "SkipIf", /** - * Represents a cool slant bevel. + * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - coolSlant = "coolSlant", + styleRef = "StyleRef", /** - * Represents a divot bevel. + * Represents that the field type is Subject. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - divot = "divot", + subject = "Subject", /** - * Represents a riblet bevel. + * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - riblet = "riblet", + subscriber = "Subscriber", /** - * Represents a hard edge bevel. + * Represents that the field type is Symbol. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - hardEdge = "hardEdge", + symbol = "Symbol", /** - * Represents an art deco bevel. + * Represents that the field type is TableOfAuthoritiesEntry. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - artDeco = "artDeco", - } - /** - * Represents color index values in a Word document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum ColorIndex { + ta = "TA", /** - * Automatically determines the color. + * Represents that the field type is TableOfContentsEntry. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - auto = "Auto", + tc = "TC", /** - * Represents the color black. + * Represents that the field type is Template. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - black = "Black", + template = "Template", /** - * Represents the color blue. + * Represents that the field type is Time. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - blue = "Blue", + time = "Time", /** - * Represents the color turquoise. + * Represents that the field type is Title. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - turquoise = "Turquoise", + title = "Title", /** - * Represents a bright green color. + * Represents that the field type is TableOfAuthorities. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - brightGreen = "BrightGreen", + toa = "TOA", /** - * Represents the color pink. + * Represents that the field type is TableOfContents. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - pink = "Pink", + toc = "TOC", /** - * Represents the color red. + * Represents that the field type is UserAddress. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - red = "Red", + userAddress = "UserAddress", /** - * Represents the color yellow. + * Represents that the field type is UserInitials. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - yellow = "Yellow", + userInitials = "UserInitials", /** - * Represents the color white. + * Represents that the field type is UserName. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - white = "White", + userName = "UserName", /** - * Represents a dark blue color. + * Represents that the field type is IndexEntry. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - darkBlue = "DarkBlue", + xe = "XE", /** - * Represents the color teal. + * Represents that the field type is Empty. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - teal = "Teal", + empty = "Empty", /** - * Represents the color green. + * Represents the field types not supported by the Office JavaScript API. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - green = "Green", + others = "Others", /** - * Represents the color violet. + * Represents that the field type is Undefined. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - violet = "Violet", + undefined = "Undefined", + } + /** + * Represents the kind of {@link Word.Field} object. Indicates how the field works in relation to updating. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldKind { /** - * Represents a dark red color. + * Represents that the field is invalid. For example, a pair of field characters with nothing inside. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - darkRed = "DarkRed", + none = "None", /** - * Represents a dark yellow color. + * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - darkYellow = "DarkYellow", + hot = "Hot", /** - * Represents a gray color with 50% intensity. + * Represents that the field is automatically updated when the source changes or the field can be manually updated. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - gray50 = "Gray50", + warm = "Warm", /** - * Represents a gray color with 25% intensity. + * Represents that the field doesn't have a result. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - gray25 = "Gray25", + cold = "Cold", + } + /** + * Represents the character inserted after the {@link Word.ListItem | list item} mark. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum TrailingCharacter { /** - * Represents a classic red color. + * A tab is inserted. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - classicRed = "ClassicRed", + trailingTab = "TrailingTab", /** - * Represents a classic blue color. + * A space is inserted. Default. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - classicBlue = "ClassicBlue", + trailingSpace = "TrailingSpace", /** - * Represents a color determined by the author. + * No character is inserted. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - byAuthor = "ByAuthor", + trailingNone = "TrailingNone", } /** - * Specifies the color type. + * Represents the built-in number styles for lists in Word. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - enum ColorType { + enum ListBuiltInNumberStyle { /** - * Represents an RGB color type. + * No built-in number style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - rgb = "rgb", + none = "None", /** - * Represents a scheme color type. + * Arabic numerals (1, 2, 3, ...). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - scheme = "scheme", - } - /** - * Specifies whether the formatting from the previous list can be continued. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum Continue { + arabic = "Arabic", /** - * Formatting cannot continue from the previous list. + * Uppercase Roman numerals (I, II, III, ...). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - disabled = "Disabled", + upperRoman = "UpperRoman", /** - * Formatting can continue from the previous list. + * Lowercase Roman numerals (i, ii, iii, ...). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - list = "List", + lowerRoman = "LowerRoman", /** - * Numbering can be restarted. + * Uppercase letters (A, B, C, ...). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - reset = "Reset", - } - /** - * Specifies the default list behavior for a list. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum DefaultListBehavior { + upperLetter = "UpperLetter", /** - * Use formatting compatible with Microsoft Word 97. + * Lowercase letters (a, b, c, ...). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - word97 = "Word97", + lowerLetter = "LowerLetter", /** - * Use Web-oriented formatting as introduced in Microsoft Word 2000. + * Ordinal numbers (1st, 2nd, 3rd, ...). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - word2000 = "Word2000", + ordinal = "Ordinal", /** - * Use formatting compatible with Microsoft Word 2002. + * Cardinal numbers as text (one, two, three, ...). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - word2002 = "Word2002", - } - /** - * Specifies the type of emphasis mark to use for a character or designated character string. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum EmphasisMark { + cardinalText = "CardinalText", /** - * No emphasis mark. + * Ordinal numbers as text (first, second, third, ...). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - none = "None", + ordinalText = "OrdinalText", /** - * Emphasis mark over a solid circle. + * Kanji. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - overSolidCircle = "OverSolidCircle", + kanji = "Kanji", /** - * Emphasis mark over a comma. + * Kanji digits. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - overComma = "OverComma", + kanjiDigit = "KanjiDigit", /** - * Emphasis mark over a white circle. + * Aiueo half width characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - overWhiteCircle = "OverWhiteCircle", + aiueoHalfWidth = "AiueoHalfWidth", /** - * Emphasis mark under a solid circle. + * Iroha half width characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - underSolidCircle = "UnderSolidCircle", - } - /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum ExtrusionColorType { + irohaHalfWidth = "IrohaHalfWidth", /** - * Represents a mixed extrusion color type. + * Arabic full-width numbers. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - mixed = "mixed", + arabicFullWidth = "ArabicFullWidth", /** - * Represents an automatic extrusion color based on the shape's fill. + * Traditional Kanji characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - automatic = "automatic", + kanjiTraditional = "KanjiTraditional", /** - * Represents a custom extrusion color independent of the shape's fill. + * Traditional Kanji characters (alternative form). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - custom = "custom", - } - /** - * Specifies a shape's fill type. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum FillType { + kanjiTraditional2 = "KanjiTraditional2", /** - * Represents a mixed fill type. + * Numbers enclosed in a circle. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - mixed = "Mixed", + numberInCircle = "NumberInCircle", /** - * Represents a solid fill type. + * Aiueo characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - solid = "Solid", + aiueo = "Aiueo", /** - * Represents a patterned fill type. + * Iroha characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - patterned = "Patterned", + iroha = "Iroha", /** - * Represents a gradient fill type. + * Arabic full-width numbers with leading zeros. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - gradient = "Gradient", + arabicLZ = "ArabicLZ", /** - * Represents a textured fill type. + * Bullet characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - textured = "Textured", + bullet = "Bullet", /** - * Represents a background fill type. + * Ganada characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - background = "Background", + ganada = "Ganada", /** - * Represents a picture fill type. + * Chosung characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - picture = "Picture", - } - /** - * Specifies the type of gradient used in a shape's fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum GradientColorType { + chosung = "Chosung", /** - * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. + * GBNum1 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - mixed = "Mixed", + gbnum1 = "GBNum1", /** - * Gradient with a single color and varying transparency or brightness. + * GBNum2 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - oneColor = "OneColor", + gbnum2 = "GBNum2", /** - * Gradient that blends two distinct colors. + * GBNum3 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - twoColors = "TwoColors", + gbnum3 = "GBNum3", /** - * Gradient that uses a predefined set of colors. + * GBNum4 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - presetColors = "PresetColors", + gbnum4 = "GBNum4", /** - * Gradient that includes more than two colors, often customized. + * Zodiac1 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - multiColor = "MultiColor", - } - /** - * Specifies the style for a gradient fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum GradientStyle { + zodiac1 = "Zodiac1", /** - * Represents a mixed gradient style. + * Zodiac2 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - mixed = "Mixed", + zodiac2 = "Zodiac2", /** - * Represents a horizontal gradient style. + * Zodiac3 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - horizontal = "Horizontal", + zodiac3 = "Zodiac3", /** - * Represents a vertical gradient style. + * Traditional Chinese numbers (style 1). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - vertical = "Vertical", + tradChinNum1 = "TradChinNum1", /** - * Represents a diagonal-up gradient style. + * Traditional Chinese numbers (style 2). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - diagonalUp = "DiagonalUp", + tradChinNum2 = "TradChinNum2", /** - * Represents a diagonal-down gradient style. + * Traditional Chinese numbers (style 3). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - diagonalDown = "DiagonalDown", + tradChinNum3 = "TradChinNum3", /** - * Represents a gradient style from the corner. + * Traditional Chinese numbers (style 4). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - fromCorner = "FromCorner", + tradChinNum4 = "TradChinNum4", /** - * Represents a gradient style from the title. + * Simplified Chinese numbers (style 1). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - fromTitle = "FromTitle", + simpChinNum1 = "SimpChinNum1", /** - * Represents a gradient style from the center. + * Simplified Chinese numbers (style 2). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - fromCenter = "FromCenter", - } - /** - * Specifies the type of ligature applied to a font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum Ligature { + simpChinNum2 = "SimpChinNum2", /** - * No ligatures applied. + * Simplified Chinese numbers (style 3). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - none = "None", + simpChinNum3 = "SimpChinNum3", /** - * Standard ligatures applied. + * Simplified Chinese numbers (style 4). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - standard = "Standard", + simpChinNum4 = "SimpChinNum4", /** - * Contextual ligatures applied. + * Hanja read numbers. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - contextual = "Contextual", + hanjaRead = "HanjaRead", /** - * Standard and contextual ligatures applied. + * Hanja read digits. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - standardContextual = "StandardContextual", - /** - * Historical ligatures applied. - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - historical = "Historical", + hanjaReadDigit = "HanjaReadDigit", /** - * Standard and historical ligatures applied. + * Hangul characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - standardHistorical = "StandardHistorical", + hangul = "Hangul", /** - * Contextual and historical ligatures applied. + * Hanja characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - contextualHistorical = "ContextualHistorical", + hanja = "Hanja", /** - * Standard, contextual, and historical ligatures applied. + * Hebrew1 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - standardContextualHistorical = "StandardContextualHistorical", + hebrew1 = "Hebrew1", /** - * Discretional ligatures applied. + * Arabic1 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - discretional = "Discretional", + arabic1 = "Arabic1", /** - * Standard and discretional ligatures applied. + * Hebrew2 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - standardDiscretional = "StandardDiscretional", + hebrew2 = "Hebrew2", /** - * Contextual and discretional ligatures applied. + * Arabic2 characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - contextualDiscretional = "ContextualDiscretional", + arabic2 = "Arabic2", /** - * Standard, contextual, and discretional ligatures applied. + * Hindi letter style 1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - standardContextualDiscretional = "StandardContextualDiscretional", + hindiLetter1 = "HindiLetter1", /** - * Historical and discretional ligatures applied. + * Hindi letter style 2. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - historicalDiscretional = "HistoricalDiscretional", + hindiLetter2 = "HindiLetter2", /** - * Standard, historical, and discretional ligatures applied. + * Hindi Arabic style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - standardHistoricalDiscretional = "StandardHistoricalDiscretional", + hindiArabic = "HindiArabic", /** - * Contextual, historical, and discretional ligatures applied. + * Hindi cardinal text. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", + hindiCardinalText = "HindiCardinalText", /** - * All ligatures applied. + * Thai letter characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - all = "All", - } - /** - * Indicates the effects lighting for an object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum LightRigType { + thaiLetter = "ThaiLetter", /** - * Represents a mixed light rig type. + * Thai Arabic characters. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - mixed = "Mixed", + thaiArabic = "ThaiArabic", /** - * Represents legacy flat light rig type 1. + * Thai cardinal text. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyFlat1 = "LegacyFlat1", + thaiCardinalText = "ThaiCardinalText", /** - * Represents legacy flat light rig type 2. + * Vietnamese cardinal text. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyFlat2 = "LegacyFlat2", + vietCardinalText = "VietCardinalText", /** - * Represents legacy flat light rig type 3. + * Lowercase Russian. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyFlat3 = "LegacyFlat3", + lowercaseRussian = "LowercaseRussian", /** - * Represents legacy flat light rig type 4. + * Uppercase Russian. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyFlat4 = "LegacyFlat4", + uppercaseRussian = "UppercaseRussian", /** - * Represents legacy normal light rig type 1. + * Lowercase Greek. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyNormal1 = "LegacyNormal1", + lowercaseGreek = "LowercaseGreek", /** - * Represents legacy normal light rig type 2. + * Uppercase Greek. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyNormal2 = "LegacyNormal2", + uppercaseGreek = "UppercaseGreek", /** - * Represents legacy normal light rig type 3. + * Arabic numbers with leading zeros (style 2). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyNormal3 = "LegacyNormal3", + arabicLZ2 = "ArabicLZ2", /** - * Represents legacy normal light rig type 4. + * Arabic numbers with leading zeros (style 3). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyNormal4 = "LegacyNormal4", + arabicLZ3 = "ArabicLZ3", /** - * Represents legacy harsh light rig type 1. + * Arabic numbers with leading zeros (style 4). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyHarsh1 = "LegacyHarsh1", + arabicLZ4 = "ArabicLZ4", /** - * Represents legacy harsh light rig type 2. + * Lowercase Turkish. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyHarsh2 = "LegacyHarsh2", + lowercaseTurkish = "LowercaseTurkish", /** - * Represents legacy harsh light rig type 3. + * Uppercase Turkish. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyHarsh3 = "LegacyHarsh3", + uppercaseTurkish = "UppercaseTurkish", /** - * Represents legacy harsh light rig type 4. + * Lowercase Bulgarian. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - legacyHarsh4 = "LegacyHarsh4", + lowercaseBulgarian = "LowercaseBulgarian", /** - * Represents a three-point light rig type. + * Uppercase Bulgarian. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - threePoint = "ThreePoint", + uppercaseBulgarian = "UppercaseBulgarian", /** - * Represents a balanced light rig type. + * Picture bullet. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - balanced = "Balanced", + pictureBullet = "PictureBullet", /** - * Represents a soft light rig type. + * Legal numbering style. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - soft = "Soft", + legal = "Legal", /** - * Represents a harsh light rig type. + * Legal numbering style with leading zeros. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - harsh = "Harsh", + legalLZ = "LegalLZ", + } + /** + * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ShadingTextureType { /** - * Represents a flood light rig type. + * Represents dark diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - flood = "Flood", + darkDiagonalDown = "DarkDiagonalDown", /** - * Represents a contrasting light rig type. + * Represents dark diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - contrasting = "Contrasting", + darkDiagonalUp = "DarkDiagonalUp", /** - * Represents a morning light rig type. + * Represents dark horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - morning = "Morning", + darkGrid = "DarkGrid", /** - * Represents a sunrise light rig type. + * Represents dark horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - sunrise = "Sunrise", + darkHorizontal = "DarkHorizontal", /** - * Represents a sunset light rig type. + * Represents dark diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - sunset = "Sunset", + darkTrellis = "DarkTrellis", /** - * Represents a chilly light rig type. + * Represents dark vertical texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - chilly = "Chilly", + darkVertical = "DarkVertical", /** - * Represents a freezing light rig type. + * Represents light diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - freezing = "Freezing", + lightDiagonalDown = "LightDiagonalDown", /** - * Represents a flat light rig type. + * Represents light diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - flat = "Flat", + lightDiagonalUp = "LightDiagonalUp", /** - * Represents a two-point light rig type. + * Represents light horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - twoPoint = "TwoPoint", + lightGrid = "LightGrid", /** - * Represents a glow light rig type. + * Represents light horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - glow = "Glow", + lightHorizontal = "LightHorizontal", /** - * Represents a bright room light rig type. + * Represents light diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - brightRoom = "BrightRoom", - } - /** - * Specifies the dash style for a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum LineDashStyle { + lightTrellis = "LightTrellis", /** - * Represents a mixed dash style. + * Represents light vertical texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - mixed = "Mixed", + lightVertical = "LightVertical", /** - * Represents a solid line style. + * Represents that there's no texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - solid = "Solid", + none = "None", /** - * Represents a square dot line style. + * Represents 10 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - squareDot = "SquareDot", + percent10 = "Percent10", /** - * Represents a round dot line style. + * Represents 12.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - roundDot = "RoundDot", + percent12Pt5 = "Percent12Pt5", /** - * Represents a dashed line style. + * Represents 15 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - dash = "Dash", + percent15 = "Percent15", /** - * Represents a dash-dot line style. + * Represents 20 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - dashDot = "DashDot", + percent20 = "Percent20", /** - * Represents a dash-dot-dot line style. + * Represents 25 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - dashDotDot = "DashDotDot", + percent25 = "Percent25", /** - * Represents a long dash line style. + * Represents 30 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - longDash = "LongDash", + percent30 = "Percent30", /** - * Represents a long dash-dot line style. + * Represents 35 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - longDashDot = "LongDashDot", + percent35 = "Percent35", /** - * Represents a long dash-dot-dot line style. + * Represents 37.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - longDashDotDot = "LongDashDotDot", + percent37Pt5 = "Percent37Pt5", /** - * Represents a system dash line style. + * Represents 40 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - sysDash = "SysDash", + percent40 = "Percent40", /** - * Represents a system dot line style. + * Represents 45 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - sysDot = "SysDot", + percent45 = "Percent45", /** - * Represents a system dash-dot line style. + * Represents 5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - sysDashDot = "SysDashDot", - } - /** - * Specifies the style for a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum LineFormatStyle { + percent5 = "Percent5", /** - * Represents a mixed line style. + * Represents 50 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - mixed = "Mixed", + percent50 = "Percent50", /** - * Represents a single line style. + * Represents 55 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - single = "Single", + percent55 = "Percent55", /** - * Represents a thin-thin line style. + * Represents 60 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - thinThin = "ThinThin", + percent60 = "Percent60", /** - * Represents a thin-thick line style. + * Represents 62.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - thinThick = "ThinThick", + percent62Pt5 = "Percent62Pt5", /** - * Represents a thick-thin line style. + * Represents 65 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - thickThin = "ThickThin", + percent65 = "Percent65", /** - * Represents a thick line between two thin lines style. + * Represents 70 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - thickBetweenThin = "ThickBetweenThin", - } - /** - * Specifies the portion of a list to which to apply a list template. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum ListApplyTo { + percent70 = "Percent70", /** - * Applies the list template to the entire list. + * Represents 75 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - wholeList = "WholeList", + percent75 = "Percent75", /** - * Applies the list template from the cursor insertion point to the end of the list. + * Represents 80 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - thisPointForward = "ThisPointForward", + percent80 = "Percent80", /** - * Applies the list template to the selection. + * Represents 85 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - selection = "Selection", - } - /** - * Represents the list type. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum ListType { + percent85 = "Percent85", /** - * List with no bullets, numbering, or outlining. + * Represents 87.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - listNoNumbering = "ListNoNumbering", + percent87Pt5 = "Percent87Pt5", /** - * ListNum fields that can be used in the body of a paragraph. + * Represents 90 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - listListNumOnly = "ListListNumOnly", + percent90 = "Percent90", /** - * Bulleted list. + * Represents 95 percent texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - listBullet = "ListBullet", + percent95 = "Percent95", /** - * Simple numeric list. + * Represents solid texture. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - listSimpleNumbering = "ListSimpleNumbering", + solid = "Solid", + } + /** + * Specifies the target document for displaying document comparison differences. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum CompareTarget { /** - * Outlined list. + * Places comparison differences in the current document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - listOutlineNumbering = "ListOutlineNumbering", + compareTargetCurrent = "CompareTargetCurrent", /** - * Mixed numeric list. + * Places comparison differences in the target document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - listMixedNumbering = "ListMixedNumbering", + compareTargetSelected = "CompareTargetSelected", /** - * Picture bulleted list. + * Places comparison differences in a new document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - listPictureBullet = "ListPictureBullet", + compareTargetNew = "CompareTargetNew", } /** - * Specifies the number form setting for an OpenType font. + * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - enum NumberForm { + enum ImportedStylesConflictBehavior { /** - * Default number form setting. + * Ignore conflicting imported styles and keep the existing version of those styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - default = "Default", + ignore = "Ignore", /** - * Lining number form setting. + * Overwrite the existing styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - lining = "Lining", + overwrite = "Overwrite", /** - * Old-style number form setting. + * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - oldStyle = "OldStyle", + createNew = "CreateNew", } /** - * Specifies the number spacing setting for an OpenType font. + * Represents the shape type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - enum NumberSpacing { + enum ShapeType { /** - * Default number spacing setting. + * Unsupported shape type. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - default = "Default", + unsupported = "Unsupported", /** - * Proportional number spacing setting. + * Text box shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - proportional = "Proportional", + textBox = "TextBox", /** - * Tabular number spacing setting. + * Geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - tabular = "Tabular", - } - /** - * Specifies the type of numbers in a list. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum NumberType { + geometricShape = "GeometricShape", /** - * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. + * Group shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - paragraph = "Paragraph", + group = "Group", /** - * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. + * Picture shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - listNum = "ListNum", + picture = "Picture", /** - * Default value for all other cases. + * Canvas shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - allNumbers = "AllNumbers", + canvas = "Canvas", } /** - * Specifies the fill pattern used in a shape. + * Represents what the horizontal position of a shape is relative to. + For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - enum PatternType { + enum RelativeHorizontalPosition { /** - * Represents a mixed pattern type. + * Relative to margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + margin = "Margin", /** - * Represents a 5 percent fill pattern. + * Relative to page. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent5 = "Percent5", + page = "Page", /** - * Represents a 10 percent fill pattern. + * Relative to column. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent10 = "Percent10", + column = "Column", /** - * Represents a 20 percent fill pattern. + * Relative to character. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent20 = "Percent20", + character = "Character", /** - * Represents a 25 percent fill pattern. + * Relative to left margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent25 = "Percent25", + leftMargin = "LeftMargin", /** - * Represents a 30 percent fill pattern. + * Relative to right margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent30 = "Percent30", + rightMargin = "RightMargin", /** - * Represents a 40 percent fill pattern. + * Relative to inside margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent40 = "Percent40", + insideMargin = "InsideMargin", /** - * Represents a 50 percent fill pattern. + * Relative to outside margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent50 = "Percent50", + outsideMargin = "OutsideMargin", + } + /** + * Represents what the vertical position of a shape is relative to. + For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum RelativeVerticalPosition { /** - * Represents a 60 percent fill pattern. + * Relative to margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent60 = "Percent60", + margin = "Margin", /** - * Represents a 70 percent fill pattern. + * Relative to page. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent70 = "Percent70", + page = "Page", /** - * Represents a 75 percent fill pattern. + * Relative to paragraph. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent75 = "Percent75", + paragraph = "Paragraph", /** - * Represents an 80 percent fill pattern. + * Relative to line. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent80 = "Percent80", + line = "Line", /** - * Represents a 90 percent fill pattern. + * Relative to top margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - percent90 = "Percent90", + topMargin = "TopMargin", /** - * Represents a dark horizontal fill pattern. + * Relative to bottom margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - darkHorizontal = "DarkHorizontal", + bottomMargin = "BottomMargin", /** - * Represents a dark vertical fill pattern. + * Relative to inside margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - darkVertical = "DarkVertical", + insideMargin = "InsideMargin", /** - * Represents a dark downward diagonal fill pattern. + * Relative to outside margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - darkDownwardDiagonal = "DarkDownwardDiagonal", + outsideMargin = "OutsideMargin", + } + /** + * Represents what the horizontal or vertical size of a shape is relative to. + For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum RelativeSize { /** - * Represents a dark upward diagonal fill pattern. + * Relative to margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - darkUpwardDiagonal = "DarkUpwardDiagonal", + margin = "Margin", /** - * Represents a small checkerboard fill pattern. + * Relative to page. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - smallCheckerBoard = "SmallCheckerBoard", + page = "Page", /** - * Represents a trellis fill pattern. + * Relative to top margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - trellis = "Trellis", + topMargin = "TopMargin", /** - * Represents a light horizontal fill pattern. + * Relative to bottom margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - lightHorizontal = "LightHorizontal", + bottomMargin = "BottomMargin", /** - * Represents a light vertical fill pattern. + * Relative to inside margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - lightVertical = "LightVertical", + insideMargin = "InsideMargin", /** - * Represents a light downward diagonal fill pattern. + * Relative to outside margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - lightDownwardDiagonal = "LightDownwardDiagonal", + outsideMargin = "OutsideMargin", + } + /** + * Specifies the shape type for a {@link Word.ShapeType | ShapeType.geometricShape} object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum GeometricShapeType { /** - * Represents a light upward diagonal fill pattern. + * Line inverse geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - lightUpwardDiagonal = "LightUpwardDiagonal", + lineInverse = "LineInverse", /** - * Represents a small grid fill pattern. + * Triangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - smallGrid = "SmallGrid", + triangle = "Triangle", /** - * Represents a dotted diamond fill pattern. + * Right triangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - dottedDiamond = "DottedDiamond", + rightTriangle = "RightTriangle", /** - * Represents a wide downward diagonal fill pattern. + * Rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - wideDownwardDiagonal = "WideDownwardDiagonal", + rectangle = "Rectangle", /** - * Represents a wide upward diagonal fill pattern. + * Diamond geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - wideUpwardDiagonal = "WideUpwardDiagonal", + diamond = "Diamond", /** - * Represents a dashed upward diagonal fill pattern. + * Parallelogram geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - dashedUpwardDiagonal = "DashedUpwardDiagonal", + parallelogram = "Parallelogram", /** - * Represents a dashed downward diagonal fill pattern. + * Trapezoid geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - dashedDownwardDiagonal = "DashedDownwardDiagonal", + trapezoid = "Trapezoid", /** - * Represents a narrow vertical fill pattern. + * Non-isosceles trapezoid geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - narrowVertical = "NarrowVertical", + nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", /** - * Represents a narrow horizontal fill pattern. + * Pentagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - narrowHorizontal = "NarrowHorizontal", + pentagon = "Pentagon", /** - * Represents a dashed vertical fill pattern. + * Hexagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - dashedVertical = "DashedVertical", + hexagon = "Hexagon", /** - * Represents a dashed horizontal fill pattern. + * Heptagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - dashedHorizontal = "DashedHorizontal", + heptagon = "Heptagon", /** - * Represents a large confetti fill pattern. + * Octagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - largeConfetti = "LargeConfetti", + octagon = "Octagon", /** - * Represents a large grid fill pattern. + * Decagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - largeGrid = "LargeGrid", + decagon = "Decagon", /** - * Represents a horizontal brick fill pattern. + * Dodecagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalBrick = "HorizontalBrick", + dodecagon = "Dodecagon", /** - * Represents a large checkerboard fill pattern. + * Star 4-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - largeCheckerBoard = "LargeCheckerBoard", + star4 = "Star4", /** - * Represents a small confetti fill pattern. + * Star 5-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - smallConfetti = "SmallConfetti", + star5 = "Star5", /** - * Represents a zigzag fill pattern. + * Star 6-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - zigZag = "ZigZag", + star6 = "Star6", /** - * Represents a solid diamond fill pattern. + * Star 7-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - solidDiamond = "SolidDiamond", + star7 = "Star7", /** - * Represents a diagonal brick fill pattern. + * Star 8-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - diagonalBrick = "DiagonalBrick", + star8 = "Star8", /** - * Represents an outlined diamond fill pattern. + * Star 10-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - outlinedDiamond = "OutlinedDiamond", + star10 = "Star10", /** - * Represents a plaid fill pattern. + * Star 12-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - plaid = "Plaid", + star12 = "Star12", /** - * Represents a sphere fill pattern. + * Star 16-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - sphere = "Sphere", + star16 = "Star16", /** - * Represents a weave fill pattern. + * Star 24-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - weave = "Weave", + star24 = "Star24", /** - * Represents a dotted grid fill pattern. + * Star 32-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - dottedGrid = "DottedGrid", + star32 = "Star32", /** - * Represents a divot fill pattern. + * Round rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - divot = "Divot", + roundRectangle = "RoundRectangle", /** - * Represents a shingle fill pattern. + * Round one rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - shingle = "Shingle", + round1Rectangle = "Round1Rectangle", /** - * Represents a wave fill pattern. + * Round two same rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - wave = "Wave", + round2SameRectangle = "Round2SameRectangle", /** - * Represents a horizontal fill pattern. + * Round two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontal = "Horizontal", + round2DiagonalRectangle = "Round2DiagonalRectangle", /** - * Represents a vertical fill pattern. + * Snip round rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - vertical = "Vertical", + snipRoundRectangle = "SnipRoundRectangle", /** - * Represents a cross fill pattern. + * Snip one rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - cross = "Cross", + snip1Rectangle = "Snip1Rectangle", /** - * Represents a downward diagonal fill pattern. + * Snip two same rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - downwardDiagonal = "DownwardDiagonal", + snip2SameRectangle = "Snip2SameRectangle", /** - * Represents an upward diagonal fill pattern. + * Snip two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - upwardDiagonal = "UpwardDiagonal", + snip2DiagonalRectangle = "Snip2DiagonalRectangle", /** - * Represents a diagonal cross fill pattern. + * Plaque geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - diagonalCross = "DiagonalCross", - } - /** - * Indicates the effects camera type used by the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum PresetCamera { + plaque = "Plaque", /** - * Represents a mixed camera type. + * Ellipse geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + ellipse = "Ellipse", /** - * Represents a legacy oblique top-left camera type. + * Teardrop geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyObliqueTopLeft = "LegacyObliqueTopLeft", + teardrop = "Teardrop", /** - * Represents a legacy oblique top camera type. + * Home plate geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyObliqueTop = "LegacyObliqueTop", + homePlate = "HomePlate", /** - * Represents a legacy oblique top-right camera type. + * Chevron geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyObliqueTopRight = "LegacyObliqueTopRight", + chevron = "Chevron", /** - * Represents a legacy oblique left camera type. + * Pie wedge geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyObliqueLeft = "LegacyObliqueLeft", + pieWedge = "PieWedge", /** - * Represents a legacy oblique front camera type. + * Pie geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyObliqueFront = "LegacyObliqueFront", + pie = "Pie", /** - * Represents a legacy oblique right camera type. + * Block arc geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyObliqueRight = "LegacyObliqueRight", + blockArc = "BlockArc", /** - * Represents a legacy oblique bottom-left camera type. + * Donut geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", + donut = "Donut", /** - * Represents a legacy oblique bottom camera type. + * No smoking geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyObliqueBottom = "LegacyObliqueBottom", + noSmoking = "NoSmoking", /** - * Represents a legacy oblique bottom-right camera type. + * Right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyObliqueBottomRight = "LegacyObliqueBottomRight", + rightArrow = "RightArrow", /** - * Represents a legacy perspective top-left camera type. + * Left arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", + leftArrow = "LeftArrow", /** - * Represents a legacy perspective top camera type. + * Up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyPerspectiveTop = "LegacyPerspectiveTop", + upArrow = "UpArrow", /** - * Represents a legacy perspective top-right camera type. + * Down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", + downArrow = "DownArrow", /** - * Represents a legacy perspective left camera type. + * Striped right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyPerspectiveLeft = "LegacyPerspectiveLeft", + stripedRightArrow = "StripedRightArrow", /** - * Represents a legacy perspective front camera type. + * Notched right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyPerspectiveFront = "LegacyPerspectiveFront", + notchedRightArrow = "NotchedRightArrow", /** - * Represents a legacy perspective right camera type. + * Bent up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyPerspectiveRight = "LegacyPerspectiveRight", + bentUpArrow = "BentUpArrow", /** - * Represents a legacy perspective bottom-left camera type. + * Left-right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", + leftRightArrow = "LeftRightArrow", /** - * Represents a legacy perspective bottom camera type. + * Up-down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyPerspectiveBottom = "LegacyPerspectiveBottom", + upDownArrow = "UpDownArrow", /** - * Represents a legacy perspective bottom-right camera type. + * Left-up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", + leftUpArrow = "LeftUpArrow", /** - * Represents an orthographic front camera type. + * Left-right-up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - orthographicFront = "OrthographicFront", + leftRightUpArrow = "LeftRightUpArrow", /** - * Represents an isometric top-up camera type. + * Quad arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricTopUp = "IsometricTopUp", + quadArrow = "QuadArrow", /** - * Represents an isometric top-down camera type. + * Left arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricTopDown = "IsometricTopDown", + leftArrowCallout = "LeftArrowCallout", /** - * Represents an isometric bottom-up camera type. + * Right arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricBottomUp = "IsometricBottomUp", + rightArrowCallout = "RightArrowCallout", /** - * Represents an isometric bottom-down camera type. + * Up arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricBottomDown = "IsometricBottomDown", + upArrowCallout = "UpArrowCallout", /** - * Represents an isometric left-up camera type. + * Down arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricLeftUp = "IsometricLeftUp", + downArrowCallout = "DownArrowCallout", /** - * Represents an isometric left-down camera type. + * Left-right arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricLeftDown = "IsometricLeftDown", + leftRightArrowCallout = "LeftRightArrowCallout", /** - * Represents an isometric right-up camera type. + * Up-down arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricRightUp = "IsometricRightUp", + upDownArrowCallout = "UpDownArrowCallout", /** - * Represents an isometric right-down camera type. + * Quad arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricRightDown = "IsometricRightDown", + quadArrowCallout = "QuadArrowCallout", /** - * Represents an isometric off-axis 1 left camera type. + * Bent arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis1Left = "IsometricOffAxis1Left", + bentArrow = "BentArrow", /** - * Represents an isometric off-axis 1 right camera type. + * U-turn arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis1Right = "IsometricOffAxis1Right", + uturnArrow = "UturnArrow", /** - * Represents an isometric off-axis 1 top camera type. + * Circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis1Top = "IsometricOffAxis1Top", + circularArrow = "CircularArrow", /** - * Represents an isometric off-axis 2 left camera type. + * Left circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis2Left = "IsometricOffAxis2Left", + leftCircularArrow = "LeftCircularArrow", /** - * Represents an isometric off-axis 2 right camera type. + * Left-right circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis2Right = "IsometricOffAxis2Right", + leftRightCircularArrow = "LeftRightCircularArrow", /** - * Represents an isometric off-axis 2 top camera type. + * Curved right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis2Top = "IsometricOffAxis2Top", + curvedRightArrow = "CurvedRightArrow", /** - * Represents an isometric off-axis 3 left camera type. + * Curved left arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis3Left = "IsometricOffAxis3Left", + curvedLeftArrow = "CurvedLeftArrow", /** - * Represents an isometric off-axis 3 right camera type. + * Curved up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis3Right = "IsometricOffAxis3Right", + curvedUpArrow = "CurvedUpArrow", /** - * Represents an isometric off-axis 3 bottom camera type. + * Curved down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", + curvedDownArrow = "CurvedDownArrow", /** - * Represents an isometric off-axis 4 left camera type. + * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis4Left = "IsometricOffAxis4Left", + swooshArrow = "SwooshArrow", /** - * Represents an isometric off-axis 4 right camera type. + * Cube geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis4Right = "IsometricOffAxis4Right", + cube = "Cube", /** - * Represents an isometric off-axis 4 bottom camera type. + * Can geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", + can = "Can", /** - * Represents an oblique top-left camera type. + * Lightning bolt geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - obliqueTopLeft = "ObliqueTopLeft", + lightningBolt = "LightningBolt", /** - * Represents an oblique top camera type. + * Heart geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - obliqueTop = "ObliqueTop", + heart = "Heart", /** - * Represents an oblique top-right camera type. + * Sun geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - obliqueTopRight = "ObliqueTopRight", + sun = "Sun", /** - * Represents an oblique left camera type. + * Moon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - obliqueLeft = "ObliqueLeft", + moon = "Moon", /** - * Represents an oblique right camera type. + * Smiley face geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - obliqueRight = "ObliqueRight", + smileyFace = "SmileyFace", /** - * Represents an oblique bottom-left camera type. + * Irregular seal 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - obliqueBottomLeft = "ObliqueBottomLeft", + irregularSeal1 = "IrregularSeal1", /** - * Represents an oblique bottom camera type. + * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - obliqueBottom = "ObliqueBottom", + irregularSeal2 = "IrregularSeal2", /** - * Represents an oblique bottom-right camera type. + * Folded corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - obliqueBottomRight = "ObliqueBottomRight", + foldedCorner = "FoldedCorner", /** - * Represents a perspective front camera type. + * Bevel geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveFront = "PerspectiveFront", + bevel = "Bevel", /** - * Represents a perspective left camera type. + * Frame geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveLeft = "PerspectiveLeft", + frame = "Frame", /** - * Represents a perspective right camera type. + * Half frame geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveRight = "PerspectiveRight", + halfFrame = "HalfFrame", /** - * Represents a perspective above camera type. + * Corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveAbove = "PerspectiveAbove", + corner = "Corner", /** - * Represents a perspective below camera type. + * Diagonal stripe geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveBelow = "PerspectiveBelow", + diagonalStripe = "DiagonalStripe", /** - * Represents a perspective above-left facing camera type. + * Chord geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", + chord = "Chord", /** - * Represents a perspective above-right facing camera type. + * Arc geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", + arc = "Arc", /** - * Represents a perspective contrasting-left facing camera type. + * Left bracket geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", + leftBracket = "LeftBracket", /** - * Represents a perspective contrasting-right facing camera type. + * Right bracket geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", + rightBracket = "RightBracket", /** - * Represents a perspective heroic-left facing camera type. + * Left brace geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", + leftBrace = "LeftBrace", /** - * Represents a perspective heroic-right facing camera type. + * Right brace geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", + rightBrace = "RightBrace", /** - * Represents a perspective heroic-extreme left facing camera type. + * Bracket pair geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", + bracketPair = "BracketPair", /** - * Represents a perspective heroic-extreme right facing camera type. + * Brace pair geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", + bracePair = "BracePair", /** - * Represents a relaxed perspective camera type. + * Callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveRelaxed = "PerspectiveRelaxed", + callout1 = "Callout1", /** - * Represents a moderately relaxed perspective camera type. + * Callout 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - perspectiveRelaxedModerately = "PerspectiveRelaxedModerately", - } - /** - * Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum PresetExtrusionDirection { + callout2 = "Callout2", /** - * Represents a mixed extrusion direction. + * Callout 3 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + callout3 = "Callout3", /** - * Represents an extrusion direction to the bottom-right. + * Accent callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - bottomRight = "BottomRight", + accentCallout1 = "AccentCallout1", /** - * Represents an extrusion direction to the bottom. + * Accent callout 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - bottom = "Bottom", + accentCallout2 = "AccentCallout2", /** - * Represents an extrusion direction to the bottom-left. + * Accent callout 3 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - bottomLeft = "BottomLeft", + accentCallout3 = "AccentCallout3", /** - * Represents an extrusion direction to the right. + * Border callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - right = "Right", + borderCallout1 = "BorderCallout1", /** - * Represents no extrusion direction. + * Border callout 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - none = "None", + borderCallout2 = "BorderCallout2", /** - * Represents an extrusion direction to the left. + * Border callout 3 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - left = "Left", + borderCallout3 = "BorderCallout3", /** - * Represents an extrusion direction to the top-right. + * Accent border callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - topRight = "TopRight", + accentBorderCallout1 = "AccentBorderCallout1", /** - * Represents an extrusion direction to the top. + * Accent border callout 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - top = "Top", + accentBorderCallout2 = "AccentBorderCallout2", /** - * Represents an extrusion direction to the top-left. + * Accent border callout 3 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - topLeft = "TopLeft", - } - /** - * Specifies which predefined gradient to use to fill a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum PresetGradientType { + accentBorderCallout3 = "AccentBorderCallout3", /** - * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. + * Wedge rectangle callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + wedgeRectCallout = "WedgeRectCallout", /** - * A warm gradient resembling an early sunset. + * Wedge rounded rectangle callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - earlySunset = "EarlySunset", + wedgeRRectCallout = "WedgeRRectCallout", /** - * A deeper, richer gradient resembling a late sunset. + * Wedge ellipse callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - lateSunset = "LateSunset", + wedgeEllipseCallout = "WedgeEllipseCallout", /** - * A dark gradient evoking the colors of nightfall. + * Cloud callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - nightfall = "Nightfall", + cloudCallout = "CloudCallout", /** - * A light gradient representing the colors of daybreak. + * Cloud geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - daybreak = "Daybreak", + cloud = "Cloud", /** - * A gradient that mimics the colors of the horizon. + * Ribbon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizon = "Horizon", + ribbon = "Ribbon", /** - * A warm, sandy gradient inspired by desert tones. + * Ribbon 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - desert = "Desert", + ribbon2 = "Ribbon2", /** - * A cool gradient reflecting ocean hues. + * Ellipse ribbon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - ocean = "Ocean", + ellipseRibbon = "EllipseRibbon", /** - * A soft, tranquil gradient resembling calm water. + * Ellipse ribbon 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - calmWater = "CalmWater", + ellipseRibbon2 = "EllipseRibbon2", /** - * A vivid gradient with fiery tones. + * Left-right ribbon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - fire = "Fire", + leftRightRibbon = "LeftRightRibbon", /** - * A muted gradient with fog-like softness. + * Vertical scroll geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - fog = "Fog", + verticalScroll = "VerticalScroll", /** - * A natural green gradient inspired by moss. + * Horizontal scroll geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - moss = "Moss", + horizontalScroll = "HorizontalScroll", /** - * A vibrant gradient with peacock feather colors. + * Wave geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - peacock = "Peacock", + wave = "Wave", /** - * A light, golden gradient resembling wheat. + * Double wave geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - wheat = "Wheat", + doubleWave = "DoubleWave", /** - * A warm, aged paper-like gradient. + * Plus geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - parchment = "Parchment", + plus = "Plus", /** - * A rich, reddish-brown gradient like mahogany wood. + * Flow chart process geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mahogany = "Mahogany", + flowChartProcess = "FlowChartProcess", /** - * A colorful gradient resembling a rainbow. + * Flow chart decision geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - rainbow = "Rainbow", + flowChartDecision = "FlowChartDecision", /** - * A variation of the rainbow gradient with different color emphasis. + * Flow chart input-output geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - rainbowII = "RainbowII", + flowChartInputOutput = "FlowChartInputOutput", /** - * A shiny, metallic gold gradient. + * Flow chart predefined process geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - gold = "Gold", + flowChartPredefinedProcess = "FlowChartPredefinedProcess", /** - * A variation of the gold gradient with different tones. + * Flow chart internal storage geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - goldII = "GoldII", + flowChartInternalStorage = "FlowChartInternalStorage", /** - * A metallic gradient resembling brass. + * Flow chart document geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - brass = "Brass", + flowChartDocument = "FlowChartDocument", /** - * A sleek, reflective chrome gradient. + * Flow chart multidocument geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - chrome = "Chrome", + flowChartMultidocument = "FlowChartMultidocument", /** - * A variation of the chrome gradient with alternate highlights. + * Flow chart terminator geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - chromeII = "ChromeII", + flowChartTerminator = "FlowChartTerminator", /** - * A smooth, metallic silver gradient. + * Flow chart preparation geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - silver = "Silver", + flowChartPreparation = "FlowChartPreparation", /** - * A deep blue gradient inspired by sapphire. + * Flow chart manual input geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - sapphire = "Sapphire", - } - /** - * Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum PresetLightingDirection { + flowChartManualInput = "FlowChartManualInput", /** - * Represents a mixed lighting direction. + * Flow chart manual operation geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + flowChartManualOperation = "FlowChartManualOperation", /** - * Represents lighting from the top-left. + * Flow chart connector geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] - */ - topLeft = "TopLeft", - /** - * Represents lighting from the top. - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - top = "Top", - /** - * Represents lighting from the top-right. - * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - topRight = "TopRight", + flowChartConnector = "FlowChartConnector", /** - * Represents lighting from the left. + * Flow chart punched card geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - left = "Left", + flowChartPunchedCard = "FlowChartPunchedCard", /** - * Represents no lighting. + * Flow chart punched tape geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - none = "None", + flowChartPunchedTape = "FlowChartPunchedTape", /** - * Represents lighting from the right. + * Flow chart summing junction geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - right = "Right", + flowChartSummingJunction = "FlowChartSummingJunction", /** - * Represents lighting from the bottom-left. + * Flow chart OR geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - bottomLeft = "BottomLeft", + flowChartOr = "FlowChartOr", /** - * Represents lighting from the bottom. + * Flow chart collate geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - bottom = "Bottom", + flowChartCollate = "FlowChartCollate", /** - * Represents lighting from the bottom-right. + * Flow chart sort geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - bottomRight = "BottomRight", - } - /** - * Specifies the intensity of light used on a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum PresetLightingSoftness { + flowChartSort = "FlowChartSort", /** - * Represents a mixed lighting softness. + * Flow chart extract geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + flowChartExtract = "FlowChartExtract", /** - * Represents dim lighting. + * Flow chart merge geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - dim = "Dim", + flowChartMerge = "FlowChartMerge", /** - * Represents normal lighting. + * Flow chart offline storage geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - normal = "Normal", + flowChartOfflineStorage = "FlowChartOfflineStorage", /** - * Represents bright lighting. + * Flow chart online storage geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - bright = "Bright", - } - /** - * Specifies the extrusion surface material. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum PresetMaterial { + flowChartOnlineStorage = "FlowChartOnlineStorage", /** - * Represents a mixed material type. + * Flow chart magnetic tape geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + flowChartMagneticTape = "FlowChartMagneticTape", /** - * Represents a matte material. + * Flow chart magnetic disk geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - matte = "Matte", + flowChartMagneticDisk = "FlowChartMagneticDisk", /** - * Represents a plastic material. + * Flow chart magnetic drum geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - plastic = "Plastic", + flowChartMagneticDrum = "FlowChartMagneticDrum", /** - * Represents a metal material. + * Flow chart display geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - metal = "Metal", + flowChartDisplay = "FlowChartDisplay", /** - * Represents a wireframe material. + * Flow chart delay geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - wireFrame = "WireFrame", + flowChartDelay = "FlowChartDelay", /** - * Represents a second matte material. + * Flow chart alternate process geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - matte2 = "Matte2", + flowChartAlternateProcess = "FlowChartAlternateProcess", /** - * Represents a second plastic material. + * Flow chart off-page connector geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - plastic2 = "Plastic2", + flowChartOffpageConnector = "FlowChartOffpageConnector", /** - * Represents a second metal material. + * Action button blank geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - metal2 = "Metal2", + actionButtonBlank = "ActionButtonBlank", /** - * Represents a warm matte material. + * Action button home geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - warmMatte = "WarmMatte", + actionButtonHome = "ActionButtonHome", /** - * Represents a translucent powder material. + * Action button help geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - translucentPowder = "TranslucentPowder", + actionButtonHelp = "ActionButtonHelp", /** - * Represents a powder material. + * Action button information geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - powder = "Powder", + actionButtonInformation = "ActionButtonInformation", /** - * Represents a dark edge material. + * Action button forward next geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - darkEdge = "DarkEdge", + actionButtonForwardNext = "ActionButtonForwardNext", /** - * Represents a soft edge material. + * Action button back previous geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - softEdge = "SoftEdge", + actionButtonBackPrevious = "ActionButtonBackPrevious", /** - * Represents a clear material. + * Action button end geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - clear = "Clear", + actionButtonEnd = "ActionButtonEnd", /** - * Represents a flat material. + * Action button beginning geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - flat = "Flat", + actionButtonBeginning = "ActionButtonBeginning", /** - * Represents a soft metal material. + * Action button return geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - softMetal = "SoftMetal", - } - /** - * Specifies texture to be used to fill a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum PresetTexture { + actionButtonReturn = "ActionButtonReturn", /** - * Represents a mixed texture type. + * Action button document geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + actionButtonDocument = "ActionButtonDocument", /** - * Represents a papyrus texture. + * Action button sound geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - papyrus = "Papyrus", + actionButtonSound = "ActionButtonSound", /** - * Represents a canvas texture. + * Action button movie geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - canvas = "Canvas", + actionButtonMovie = "ActionButtonMovie", /** - * Represents a denim texture. + * Gear 6 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - denim = "Denim", + gear6 = "Gear6", /** - * Represents a woven mat texture. + * Gear 9 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - wovenMat = "WovenMat", + gear9 = "Gear9", /** - * Represents a water droplets texture. + * Funnel geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - waterDroplets = "WaterDroplets", + funnel = "Funnel", /** - * Represents a paper bag texture. + * Math plus geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - paperBag = "PaperBag", + mathPlus = "MathPlus", /** - * Represents a fish fossil texture. + * Math minus geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - fishFossil = "FishFossil", + mathMinus = "MathMinus", /** - * Represents a sand texture. + * Math multiply geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - sand = "Sand", + mathMultiply = "MathMultiply", /** - * Represents a green marble texture. + * Math divide geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - greenMarble = "GreenMarble", + mathDivide = "MathDivide", /** - * Represents a white marble texture. + * Math equal geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - whiteMarble = "WhiteMarble", + mathEqual = "MathEqual", /** - * Represents a brown marble texture. + * Math not equal geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - brownMarble = "BrownMarble", + mathNotEqual = "MathNotEqual", /** - * Represents a granite texture. + * Corner tabs geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - granite = "Granite", + cornerTabs = "CornerTabs", /** - * Represents a newsprint texture. + * Square tabs geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - newsprint = "Newsprint", + squareTabs = "SquareTabs", /** - * Represents a recycled paper texture. + * Plaque tabs geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - recycledPaper = "RecycledPaper", + plaqueTabs = "PlaqueTabs", /** - * Represents a parchment texture. + * Chart X geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - parchment = "Parchment", + chartX = "ChartX", /** - * Represents a stationery texture. + * Chart star geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - stationery = "Stationery", + chartStar = "ChartStar", /** - * Represents a blue tissue paper texture. + * Chart plus geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - blueTissuePaper = "BlueTissuePaper", + chartPlus = "ChartPlus", + } + /** + * Specifies a {@link Word.Shape | shape's} fill type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeFillType { /** - * Represents a pink tissue paper texture. + * No fill. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - pinkTissuePaper = "PinkTissuePaper", + noFill = "NoFill", /** - * Represents a purple mesh texture. + * Solid fill. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - purpleMesh = "PurpleMesh", + solid = "Solid", /** - * Represents a bouquet texture. + * Gradient fill. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - bouquet = "Bouquet", + gradient = "Gradient", /** - * Represents a cork texture. + * Pattern fill. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - cork = "Cork", + pattern = "Pattern", /** - * Represents a walnut texture. + * Picture fill. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - walnut = "Walnut", + picture = "Picture", /** - * Represents an oak texture. + * Texture fill. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - oak = "Oak", + texture = "Texture", /** - * Represents a medium wood texture. + * Mixed fill. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mediumWood = "MediumWood", + mixed = "Mixed", } /** - * Specifies an extrusion (three-dimensional) format. + * Specifies the vertical alignment for the text frame in a shape. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - enum PresetThreeDimensionalFormat { + enum ShapeTextVerticalAlignment { /** - * Represents a mixed three-dimensional format. + * Anchor the text at the top of the bounding rectangle. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + top = "Top", /** - * Represents three-dimensional format 1. + * Anchor the text at the middle of the bounding rectangle. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format1 = "Format1", + middle = "Middle", /** - * Represents three-dimensional format 2. + * Anchor the text at the bottom of the bounding rectangle. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format2 = "Format2", + bottom = "Bottom", + } + /** + * Specifies the orientation for the text frame in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextOrientation { /** - * Represents three-dimensional format 3. + * No orientation, such as in a new geometric shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format3 = "Format3", + none = "None", /** - * Represents three-dimensional format 4. + * Horizontal text. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format4 = "Format4", + horizontal = "Horizontal", /** - * Represents three-dimensional format 5. + * A special version of vertical text, where some fonts are displayed as if rotated. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format5 = "Format5", + eastAsianVertical = "EastAsianVertical", /** - * Represents three-dimensional format 6. + * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format6 = "Format6", + vertical270 = "Vertical270", /** - * Represents three-dimensional format 7. + * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format7 = "Format7", + vertical = "Vertical", /** - * Represents three-dimensional format 8. + * A special version of vertical text, where some fonts are displayed as if rotated. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format8 = "Format8", + eastAsianHorizontalRotated = "EastAsianHorizontalRotated", /** - * Represents three-dimensional format 9. + * A combination of automatic orientation is used. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format9 = "Format9", + mixed = "Mixed", + } + /** + * Determines the type of automatic sizing allowed. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeAutoSize { /** - * Represents three-dimensional format 10. + * No autosizing. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format10 = "Format10", + none = "None", /** - * Represents three-dimensional format 11. + * The text is adjusted to fit the shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format11 = "Format11", + textToFitShape = "TextToFitShape", /** - * Represents three-dimensional format 12. + * The shape is adjusted to fit the text. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format12 = "Format12", + shapeToFitText = "ShapeToFitText", /** - * Represents three-dimensional format 13. + * A combination of automatic sizing schemes are used. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format13 = "Format13", + mixed = "Mixed", + } + /** + * Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextWrapType { /** - * Represents three-dimensional format 14. + * Places the shape in line with text. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format14 = "Format14", + inline = "Inline", /** - * Represents three-dimensional format 15. + * Wraps text squarely around the shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format15 = "Format15", + square = "Square", /** - * Represents three-dimensional format 16. + * Wraps text close to the shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format16 = "Format16", + tight = "Tight", /** - * Represents three-dimensional format 17. + * Wraps text around and through the shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format17 = "Format17", + through = "Through", /** - * Represents three-dimensional format 18. + * Places text above and below the shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format18 = "Format18", + topBottom = "TopBottom", /** - * Represents three-dimensional format 19. + * Places shape behind text. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format19 = "Format19", + behind = "Behind", /** - * Represents three-dimensional format 20. + * Places shape in front of text. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - format20 = "Format20", + front = "Front", } /** - * Specifies the type of the {@link Word.ReflectionFormat} object. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - enum ReflectionType { - /** - * Represents a mixed reflection type. - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - mixed = "Mixed", + enum ShapeTextWrapSide { /** - * Represents no reflection. + * Has no wrap side property, such as those for inline shapes. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ none = "None", /** - * Represents reflection type 1. + * Both left and right sides of the shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - type1 = "Type1", + both = "Both", /** - * Represents reflection type 2. + * Left side of the shape only. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - type2 = "Type2", + left = "Left", /** - * Represents reflection type 3. + * Right side of the shape only. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - type3 = "Type3", + right = "Right", /** - * Represents reflection type 4. + * Side of the shape that's farther from the respective page margin. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - type4 = "Type4", + largest = "Largest", + } + /** + * Specifies the scale size type of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleType { /** - * Represents reflection type 5. + * Scale from current size of the shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - type5 = "Type5", + currentSize = "CurrentSize", /** - * Represents reflection type 6. + * Scale from original size of the shape. It only works for pictures. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - type6 = "Type6", + originalSize = "OriginalSize", + } + /** + * Specifies which part of the shape retains its position when the shape is scaled. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleFrom { /** - * Represents reflection type 7. + * Scale from the top left corner of the shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - type7 = "Type7", + scaleFromTopLeft = "ScaleFromTopLeft", /** - * Represents reflection type 8. + * Scale from the center of the shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - type8 = "Type8", + scaleFromMiddle = "ScaleFromMiddle", /** - * Represents reflection type 9. + * Scale from the bottom right corner of the shape. * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - type9 = "Type9", + scaleFromBottomRight = "ScaleFromBottomRight", } /** - * Specifies the type of shadowing effect. + * Represents how Word interprets the rule used to determine the height or width of a {@link Word.Frame}. * * @remarks * [Api set: WordApiDesktop 1.3] */ - enum ShadowStyle { + enum FrameSizeRule { /** - * Represents a mixed shadow style. + * The height or width is set according to the height or width of the item in the frame. * @remarks * [Api set: WordApiDesktop 1.3] */ - mixed = "Mixed", + auto = "Auto", /** - * Represents an outer shadow style. + * The height or width is set to a value equal to or greater than the value specified by the `height` property or `width` property. * @remarks * [Api set: WordApiDesktop 1.3] */ - outerShadow = "OuterShadow", + atLeast = "AtLeast", /** - * Represents an inner shadow style. + * The height or width is set to an exact value specified by the `height` property or `width` property. * @remarks * [Api set: WordApiDesktop 1.3] */ - innerShadow = "InnerShadow", + exact = "Exact", } /** - * Specifies the type of shadow displayed with a shape. + * Specifies the {@link Word.BorderUniversal | border } style for an object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - enum ShadowType { + enum BorderLineStyle { /** - * Represents a mixed shadow type. + * No line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - mixed = "Mixed", + none = "None", /** - * Represents shadow type 1. + * Single line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type1 = "Type1", + single = "Single", /** - * Represents shadow type 2. + * Dotted line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type2 = "Type2", + dot = "Dot", /** - * Represents shadow type 3. + * Dashed line style with small gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type3 = "Type3", + dashSmallGap = "DashSmallGap", /** - * Represents shadow type 4. + * Dashed line style with large gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type4 = "Type4", + dashLargeGap = "DashLargeGap", /** - * Represents shadow type 5. + * Dash-dot line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type5 = "Type5", + dashDot = "DashDot", /** - * Represents shadow type 6. + * Dash-dot-dot line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type6 = "Type6", + dashDotDot = "DashDotDot", /** - * Represents shadow type 7. + * Double line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type7 = "Type7", + double = "Double", /** - * Represents shadow type 8. + * Triple line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type8 = "Type8", + triple = "Triple", /** - * Represents shadow type 9. + * Thin-thick line style with small gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type9 = "Type9", + thinThickSmallGap = "ThinThickSmallGap", /** - * Represents shadow type 10. + * Thick-thin line style with small gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type10 = "Type10", + thickThinSmallGap = "ThickThinSmallGap", /** - * Represents shadow type 11. + * Thin-thick-thin line style with small gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type11 = "Type11", + thinThickThinSmallGap = "ThinThickThinSmallGap", /** - * Represents shadow type 12. + * Thin-thick line style with medium gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type12 = "Type12", + thinThickMedGap = "ThinThickMedGap", /** - * Represents shadow type 13. + * Thick-thin line style with medium gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type13 = "Type13", + thickThinMedGap = "ThickThinMedGap", /** - * Represents shadow type 14. + * Thin-thick-thin line style with medium gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type14 = "Type14", + thinThickThinMedGap = "ThinThickThinMedGap", /** - * Represents shadow type 15. + * Thin-thick line style with large gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type15 = "Type15", + thinThickLargeGap = "ThinThickLargeGap", /** - * Represents shadow type 16. + * Thick-thin line style with large gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type16 = "Type16", + thickThinLargeGap = "ThickThinLargeGap", /** - * Represents shadow type 17. + * Thin-thick-thin line style with large gaps. * @remarks * [Api set: WordApiDesktop 1.3] */ - type17 = "Type17", + thinThickThinLargeGap = "ThinThickThinLargeGap", /** - * Represents shadow type 18. + * Single wavy line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type18 = "Type18", + singleWavy = "SingleWavy", /** - * Represents shadow type 19. + * Double wavy line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type19 = "Type19", + doubleWavy = "DoubleWavy", /** - * Represents shadow type 20. + * Dash-dot stroked line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type20 = "Type20", + dashDotStroked = "DashDotStroked", /** - * Represents shadow type 21. + * Embossed 3D line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type21 = "Type21", + emboss3D = "Emboss3D", /** - * Represents shadow type 22. + * Engraved 3D line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type22 = "Type22", + engrave3D = "Engrave3D", /** - * Represents shadow type 23. + * Outset line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type23 = "Type23", + outset = "Outset", /** - * Represents shadow type 24. + * Inset line style. * @remarks * [Api set: WordApiDesktop 1.3] */ - type24 = "Type24", + inset = "Inset", + } + /** + * Specifies the width of an object's {@link Word.BorderUniversal | border}. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum LineWidth { /** - * Represents shadow type 25. + * Represents a line width of 0.25 points. * @remarks * [Api set: WordApiDesktop 1.3] */ - type25 = "Type25", + pt025 = "Pt025", /** - * Represents shadow type 26. + * Represents a line width of 0.50 points. * @remarks * [Api set: WordApiDesktop 1.3] */ - type26 = "Type26", + pt050 = "Pt050", /** - * Represents shadow type 27. + * Represents a line width of 0.75 points. * @remarks * [Api set: WordApiDesktop 1.3] */ - type27 = "Type27", + pt075 = "Pt075", /** - * Represents shadow type 28. + * Represents a line width of 1.00 points. * @remarks * [Api set: WordApiDesktop 1.3] */ - type28 = "Type28", + pt100 = "Pt100", /** - * Represents shadow type 29. + * Represents a line width of 1.50 points. * @remarks * [Api set: WordApiDesktop 1.3] */ - type29 = "Type29", + pt150 = "Pt150", /** - * Represents shadow type 30. + * Represents a line width of 2.25 points. * @remarks * [Api set: WordApiDesktop 1.3] */ - type30 = "Type30", + pt225 = "Pt225", /** - * Represents shadow type 31. + * Represents a line width of 3.00 points. * @remarks * [Api set: WordApiDesktop 1.3] */ - type31 = "Type31", + pt300 = "Pt300", /** - * Represents shadow type 32. + * Represents a line width of 4.50 points. * @remarks * [Api set: WordApiDesktop 1.3] */ - type32 = "Type32", + pt450 = "Pt450", /** - * Represents shadow type 33. + * Represents a line width of 6.00 points. * @remarks * [Api set: WordApiDesktop 1.3] */ - type33 = "Type33", + pt600 = "Pt600", + } + /** + * Specifies the graphical page border setting of a page. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PageBorderArt { /** - * Represents shadow type 34. + * Represents a border with apple design. * @remarks * [Api set: WordApiDesktop 1.3] */ - type34 = "Type34", + apples = "Apples", /** - * Represents shadow type 35. + * Represents a border with maple muffin design. * @remarks * [Api set: WordApiDesktop 1.3] */ - type35 = "Type35", + mapleMuffins = "MapleMuffins", /** - * Represents shadow type 36. + * Represents a border with cake slice design. * @remarks * [Api set: WordApiDesktop 1.3] */ - type36 = "Type36", + cakeSlice = "CakeSlice", /** - * Represents shadow type 37. + * Represents a border with candy corn design. * @remarks * [Api set: WordApiDesktop 1.3] */ - type37 = "Type37", + candyCorn = "CandyCorn", /** - * Represents shadow type 38. + * Represents a border with ice cream cone design. * @remarks * [Api set: WordApiDesktop 1.3] */ - type38 = "Type38", + iceCreamCones = "IceCreamCones", /** - * Represents shadow type 39. + * Represents a border with champagne bottle design. * @remarks * [Api set: WordApiDesktop 1.3] */ - type39 = "Type39", + champagneBottle = "ChampagneBottle", /** - * Represents shadow type 40. + * Represents a border with party glass design. * @remarks * [Api set: WordApiDesktop 1.3] */ - type40 = "Type40", + partyGlass = "PartyGlass", /** - * Represents shadow type 41. + * Represents a border with Christmas tree design. * @remarks * [Api set: WordApiDesktop 1.3] */ - type41 = "Type41", + christmasTree = "ChristmasTree", /** - * Represents shadow type 42. + * Represents a border with trees design. * @remarks * [Api set: WordApiDesktop 1.3] */ - type42 = "Type42", + trees = "Trees", /** - * Represents shadow type 43. + * Represents a border with palm trees in color. * @remarks * [Api set: WordApiDesktop 1.3] */ - type43 = "Type43", - } - /** - * Specifies the stylistic set to apply to the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum StylisticSet { + palmsColor = "PalmsColor", /** - * Default stylistic set. + * Represents a border with three-color balloons design. * @remarks * [Api set: WordApiDesktop 1.3] */ - default = "Default", + balloons3Colors = "Balloons3Colors", /** - * Stylistic set 01. + * Represents a border with hot air balloons design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set01 = "Set01", + balloonsHotAir = "BalloonsHotAir", /** - * Stylistic set 02. + * Represents a border with party favor design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set02 = "Set02", + partyFavor = "PartyFavor", /** - * Stylistic set 03. + * Represents a border with confetti streamers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set03 = "Set03", + confettiStreamers = "ConfettiStreamers", /** - * Stylistic set 04. + * Represents a border with hearts design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set04 = "Set04", + hearts = "Hearts", /** - * Stylistic set 05. + * Represents a border with heart balloon design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set05 = "Set05", + heartBalloon = "HeartBalloon", /** - * Stylistic set 06. + * Represents a border with 3D stars design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set06 = "Set06", + stars3D = "Stars3D", /** - * Stylistic set 07. + * Represents a border with shadowed stars design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set07 = "Set07", + starsShadowed = "StarsShadowed", /** - * Stylistic set 08. + * Represents a border with stars design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set08 = "Set08", + stars = "Stars", /** - * Stylistic set 09. + * Represents a border with sun design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set09 = "Set09", + sun = "Sun", /** - * Stylistic set 10. + * Represents a border with Earth design (variant 2). * @remarks * [Api set: WordApiDesktop 1.3] */ - set10 = "Set10", + earth2 = "Earth2", /** - * Stylistic set 11. + * Represents a border with Earth design (variant 1). * @remarks * [Api set: WordApiDesktop 1.3] */ - set11 = "Set11", + earth1 = "Earth1", /** - * Stylistic set 12. + * Represents a border with people wearing hats design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set12 = "Set12", + peopleHats = "PeopleHats", /** - * Stylistic set 13. + * Represents a border with sombrero design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set13 = "Set13", + sombrero = "Sombrero", /** - * Stylistic set 14. + * Represents a border with pencils design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set14 = "Set14", + pencils = "Pencils", /** - * Stylistic set 15. + * Represents a border with packages design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set15 = "Set15", + packages = "Packages", /** - * Stylistic set 16. + * Represents a border with clocks design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set16 = "Set16", + clocks = "Clocks", /** - * Stylistic set 17. + * Represents a border with firecrackers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set17 = "Set17", + firecrackers = "Firecrackers", /** - * Stylistic set 18. + * Represents a border with rings design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set18 = "Set18", + rings = "Rings", /** - * Stylistic set 19. + * Represents a border with map pins design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set19 = "Set19", + mapPins = "MapPins", /** - * Stylistic set 20. + * Represents a border with confetti design. * @remarks * [Api set: WordApiDesktop 1.3] */ - set20 = "Set20", - } - /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum TextureAlignment { + confetti = "Confetti", /** - * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. + * Represents a border with butterfly creatures design. * @remarks * [Api set: WordApiDesktop 1.3] */ - mixed = "Mixed", + creaturesButterfly = "CreaturesButterfly", /** - * Aligns the texture to the top-left corner of the shape. + * Represents a border with ladybug creatures design. * @remarks * [Api set: WordApiDesktop 1.3] */ - topLeft = "TopLeft", + creaturesLadyBug = "CreaturesLadyBug", /** - * Aligns the texture to the top center of the shape. + * Represents a border with fish creatures design. * @remarks * [Api set: WordApiDesktop 1.3] */ - top = "Top", + creaturesFish = "CreaturesFish", /** - * Aligns the texture to the top-right corner of the shape. + * Represents a border with birds in flight design. * @remarks * [Api set: WordApiDesktop 1.3] */ - topRight = "TopRight", + birdsFlight = "BirdsFlight", /** - * Aligns the texture to the middle left side of the shape. + * Represents a border with scared cat design. * @remarks * [Api set: WordApiDesktop 1.3] */ - left = "Left", + scaredCat = "ScaredCat", /** - * Aligns the texture to the center of the shape. + * Represents a border with bats design. * @remarks * [Api set: WordApiDesktop 1.3] */ - center = "Center", + bats = "Bats", /** - * Aligns the texture to the middle right side of the shape. + * Represents a border with roses flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - right = "Right", + flowersRoses = "FlowersRoses", /** - * Aligns the texture to the bottom-left corner of the shape. + * Represents a border with red rose flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - bottomLeft = "BottomLeft", + flowersRedRose = "FlowersRedRose", /** - * Aligns the texture to the bottom center of the shape. + * Represents a border with poinsettias flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - bottom = "Bottom", + poinsettias = "Poinsettias", /** - * Aligns the texture to the bottom-right corner of the shape. + * Represents a border with holly design. * @remarks * [Api set: WordApiDesktop 1.3] */ - bottomRight = "BottomRight", - } - /** - * Specifies the texture type for the selected fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum TextureType { + holly = "Holly", /** - * Mixed texture type. Used when multiple shapes with different texture types are selected. + * Represents a border with tiny flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - mixed = "Mixed", + flowersTiny = "FlowersTiny", /** - * A predefined texture selected from the built-in texture gallery. + * Represents a border with pansy flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - preset = "Preset", + flowersPansy = "FlowersPansy", /** - * A custom texture defined by the user, typically from an image file. + * Represents a border with modern 2 flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - userDefined = "UserDefined", - } - /** - * Specifies the theme colors for document themes. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum ThemeColorIndex { + flowersModern2 = "FlowersModern2", /** - * Not a theme color. Used when the color is not part of the theme. + * Represents a border with modern 1 flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - notThemeColor = "NotThemeColor", + flowersModern1 = "FlowersModern1", /** - * The first dark color in the main theme. + * Represents a border with white flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - mainDark1 = "MainDark1", + whiteFlowers = "WhiteFlowers", /** - * The first light color in the main theme. + * Represents a border with vine design. * @remarks * [Api set: WordApiDesktop 1.3] */ - mainLight1 = "MainLight1", + vine = "Vine", /** - * The second dark color in the main theme. + * Represents a border with daisies flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - mainDark2 = "MainDark2", + flowersDaisies = "FlowersDaisies", /** - * The second light color in the main theme. + * Represents a border with block print flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - mainLight2 = "MainLight2", + flowersBlockPrint = "FlowersBlockPrint", /** - * The first accent color in the theme. + * Represents a border with colored deco arch design. * @remarks * [Api set: WordApiDesktop 1.3] */ - accent1 = "Accent1", + decoArchColor = "DecoArchColor", /** - * The second accent color in the theme. + * Represents a border with fans design. * @remarks * [Api set: WordApiDesktop 1.3] */ - accent2 = "Accent2", + fans = "Fans", /** - * The third accent color in the theme. + * Represents a border with film design. * @remarks * [Api set: WordApiDesktop 1.3] */ - accent3 = "Accent3", + film = "Film", /** - * The fourth accent color in the theme. + * Represents a border with lightning design (variant 1). * @remarks * [Api set: WordApiDesktop 1.3] */ - accent4 = "Accent4", + lightning1 = "Lightning1", /** - * The fifth accent color in the theme. + * Represents a border with compass design. * @remarks * [Api set: WordApiDesktop 1.3] */ - accent5 = "Accent5", + compass = "Compass", /** - * The sixth accent color in the theme. + * Represents a border with double D design. * @remarks * [Api set: WordApiDesktop 1.3] */ - accent6 = "Accent6", + doubleD = "DoubleD", /** - * The color used for hyperlinks. + * Represents a border with classical wave design. * @remarks * [Api set: WordApiDesktop 1.3] */ - hyperlink = "Hyperlink", + classicalWave = "ClassicalWave", /** - * The color used for followed hyperlinks. + * Represents a border with shadowed squares design. * @remarks * [Api set: WordApiDesktop 1.3] */ - hyperlinkFollowed = "HyperlinkFollowed", + shadowedSquares = "ShadowedSquares", /** - * The first background color in the theme. + * Represents a border with twisted lines design (variant 1). * @remarks * [Api set: WordApiDesktop 1.3] */ - background1 = "Background1", + twistedLines1 = "TwistedLines1", /** - * The first text color in the theme. + * Represents a border with waveline design. * @remarks * [Api set: WordApiDesktop 1.3] */ - text1 = "Text1", + waveline = "Waveline", /** - * The second background color in the theme. + * Represents a border with quadrants design. * @remarks * [Api set: WordApiDesktop 1.3] */ - background2 = "Background2", + quadrants = "Quadrants", /** - * The second text color in the theme. + * Represents a border with colored checked bar design. * @remarks * [Api set: WordApiDesktop 1.3] */ - text2 = "Text2", - } - /** - * Specifies the hyperlink type. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum HyperlinkType { + checkedBarColor = "CheckedBarColor", /** - * Represents a hyperlink to a range in the document. + * Represents a border with swirligig design. * @remarks * [Api set: WordApiDesktop 1.3] */ - range = "Range", + swirligig = "Swirligig", /** - * Represents a hyperlink to a shape in the document. + * Represents a border with push pin note design (variant 1). * @remarks * [Api set: WordApiDesktop 1.3] */ - shape = "Shape", + pushPinNote1 = "PushPinNote1", /** - * Represents a hyperlink to an inline shape in the document. + * Represents a border with push pin note design (variant 2). * @remarks * [Api set: WordApiDesktop 1.3] */ - inlineShape = "InlineShape", - } - /** - * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class Bibliography extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + pushPinNote2 = "PushPinNote2", /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. - * + * Represents a border with pumpkin design (variant 1). * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly sources: Word.SourceCollection; + pumpkin1 = "Pumpkin1", /** - * Specifies the name of the active style to use for the bibliography. - * + * Represents a border with black eggs design. * @remarks * [Api set: WordApiDesktop 1.3] */ - bibliographyStyle: string; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.BibliographyUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Bibliography): void; + eggsBlack = "EggsBlack", /** - * Generates a unique identification tag for a bibliography source and returns a string that represents the tag. - * + * Represents a border with cup design. * @remarks * [Api set: WordApiDesktop 1.3] */ - generateUniqueTag(): OfficeExtension.ClientResult; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.Bibliography; + cup = "Cup", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Represents a border with gray heart design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Bibliography; + heartGray = "HeartGray", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with gingerbread man design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - track(): Word.Bibliography; + gingerbreadMan = "GingerbreadMan", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with baby pacifier design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - untrack(): Word.Bibliography; - /** - * 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.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.BibliographyData; - } - /** - * Represents a collection of {@link Word.Source} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class SourceCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.Source[]; + babyPacifier = "BabyPacifier", /** - * Adds a new `Source` object to the collection. - * + * Represents a border with baby rattle design. * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param xml A string containing the XML data for the source. - * @returns A `Source` object that was added to the collection. */ - add(xml: string): Word.Source; + babyRattle = "BabyRattle", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents a border with cabins design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(options?: Word.Interfaces.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; + cabins = "Cabins", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Represents a border with funky house design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNames?: string | string[]): Word.SourceCollection; + houseFunky = "HouseFunky", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Represents a border with black stars design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SourceCollection; + starsBlack = "StarsBlack", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with snowflakes design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - track(): Word.SourceCollection; + snowflakes = "Snowflakes", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with fancy snowflake design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - untrack(): Word.SourceCollection; - /** - * 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.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.SourceCollectionData; - } - /** - * Represents an individual source, such as a book, journal article, or interview. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class Source extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + snowflakeFancy = "SnowflakeFancy", /** - * Gets if the `Source` object has been cited in the document. - * + * Represents a border with skyrocket design. * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly isCited: boolean; + skyrocket = "Skyrocket", /** - * Gets the tag of the source. - * + * Represents a border with Seattle design. * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly tag: string; + seattle = "Seattle", /** - * Gets the XML representation of the source. - * + * Represents a border with music notes design. * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly xml: string; + musicNotes = "MusicNotes", /** - * Deletes the `Source` object. - * + * Represents a border with black palms design. * @remarks * [Api set: WordApiDesktop 1.3] */ - delete(): void; + palmsBlack = "PalmsBlack", /** - * Returns the value of a field in the bibliography `Source` object. - * + * Represents a border with maple leaf design. * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param name The name of the field to retrieve. */ - getFieldByName(name: string): OfficeExtension.ClientResult; + mapleLeaf = "MapleLeaf", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents a border with paper clips design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(options?: Word.Interfaces.SourceLoadOptions): Word.Source; + paperClips = "PaperClips", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Represents a border with shorebird tracks design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNames?: string | string[]): Word.Source; + shorebirdTracks = "ShorebirdTracks", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Represents a border with people design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Source; + people = "People", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with people waving design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - track(): Word.Source; + peopleWaving = "PeopleWaving", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with eclipsing squares design (variant 2). + * @remarks + * [Api set: WordApiDesktop 1.3] */ - untrack(): Word.Source; - /** - * 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.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.SourceData; - } - /** - * Represents the page setup settings for a Word document or section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class PageSetup extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + eclipsingSquares2 = "EclipsingSquares2", /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. - * + * Represents a border with hypnotic design. * @remarks * [Api set: WordApiDesktop 1.3] */ - lineNumbering: Word.LineNumbering; + hypnotic = "Hypnotic", /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. - * + * Represents a border with gray diamonds design. * @remarks * [Api set: WordApiDesktop 1.3] */ - readonly textColumns: Word.TextColumnCollection; + diamondsGray = "DiamondsGray", /** - * Specifies whether Microsoft Word prints the document as a booklet. - * + * Represents a border with deco arch design. * @remarks * [Api set: WordApiDesktop 1.3] */ - bookFoldPrinting: boolean; + decoArch = "DecoArch", /** - * Specifies the number of pages for each booklet. - * + * Represents a border with deco blocks design. * @remarks * [Api set: WordApiDesktop 1.3] */ - bookFoldPrintingSheets: number; + decoBlocks = "DecoBlocks", /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. - * + * Represents a border with circles and lines design. * @remarks * [Api set: WordApiDesktop 1.3] */ - bookFoldReversePrinting: boolean; + circlesLines = "CirclesLines", /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. - * + * Represents a border with papyrus design. * @remarks * [Api set: WordApiDesktop 1.3] */ - bottomMargin: number; + papyrus = "Papyrus", /** - * Specifies the number of characters per line in the document grid. - * + * Represents a border with woodwork design. * @remarks * [Api set: WordApiDesktop 1.3] */ - charsLine: number; + woodwork = "Woodwork", /** - * Specifies whether the first page has a different header and footer. - * + * Represents a border with weaving braid design. * @remarks * [Api set: WordApiDesktop 1.3] */ - differentFirstPageHeaderFooter: boolean; + weavingBraid = "WeavingBraid", /** - * Specifies the distance between the footer and the bottom of the page in points. - * + * Represents a border with weaving ribbon design. * @remarks * [Api set: WordApiDesktop 1.3] */ - footerDistance: number; + weavingRibbon = "WeavingRibbon", /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. - * + * Represents a border with weaving angles design. * @remarks * [Api set: WordApiDesktop 1.3] */ - gutter: number; + weavingAngles = "WeavingAngles", /** - * Specifies on which side the gutter appears in a document. - * + * Represents a border with arched scallops design. * @remarks * [Api set: WordApiDesktop 1.3] */ - gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; + archedScallops = "ArchedScallops", /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. - * + * Represents a border with safari design. * @remarks * [Api set: WordApiDesktop 1.3] */ - gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; + safari = "Safari", /** - * Specifies the distance between the header and the top of the page in points. - * + * Represents a border with Celtic knotwork design. * @remarks * [Api set: WordApiDesktop 1.3] */ - headerDistance: number; + celticKnotwork = "CelticKnotwork", /** - * Specifies the layout mode for the current document. - * + * Represents a border with crazy maze design. * @remarks * [Api set: WordApiDesktop 1.3] */ - layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + crazyMaze = "CrazyMaze", /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. - * + * Represents a border with eclipsing squares design (variant 1). * @remarks * [Api set: WordApiDesktop 1.3] */ - leftMargin: number; + eclipsingSquares1 = "EclipsingSquares1", /** - * Specifies the number of lines per page in the document grid. - * + * Represents a border with birds design. * @remarks * [Api set: WordApiDesktop 1.3] */ - linesPage: number; + birds = "Birds", /** - * Specifies if the inside and outside margins of facing pages are the same width. - * + * Represents a border with teacup and flowers design. * @remarks * [Api set: WordApiDesktop 1.3] */ - mirrorMargins: boolean; + flowersTeacup = "FlowersTeacup", /** - * Specifies whether odd and even pages have different headers and footers. - * + * Represents a border with northwest design. * @remarks * [Api set: WordApiDesktop 1.3] */ - oddAndEvenPagesHeaderFooter: boolean; + northwest = "Northwest", /** - * Specifies the orientation of the page. - * + * Represents a border with southwest design. * @remarks * [Api set: WordApiDesktop 1.3] */ - orientation: Word.PageOrientation | "Portrait" | "Landscape"; + southwest = "Southwest", /** - * Specifies the page height in points. - * + * Represents a border with tribal design (variant 6). * @remarks * [Api set: WordApiDesktop 1.3] */ - pageHeight: number; + tribal6 = "Tribal6", /** - * Specifies the page width in points. - * + * Represents a border with tribal design (variant 4). * @remarks * [Api set: WordApiDesktop 1.3] */ - pageWidth: number; + tribal4 = "Tribal4", /** - * Specifies the paper size of the page. - * + * Represents a border with tribal design (variant 3). * @remarks * [Api set: WordApiDesktop 1.3] */ - paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + tribal3 = "Tribal3", /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. - * + * Represents a border with tribal design (variant 2). * @remarks * [Api set: WordApiDesktop 1.3] */ - rightMargin: number; + tribal2 = "Tribal2", /** - * Specifies the reading order and alignment for the specified sections. - * + * Represents a border with tribal design (variant 5). * @remarks * [Api set: WordApiDesktop 1.3] */ - sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + tribal5 = "Tribal5", /** - * Specifies the type of section break for the specified object. - * + * Represents a border with X illusions design. * @remarks * [Api set: WordApiDesktop 1.3] */ - sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + xillusions = "XIllusions", /** - * Specifies whether to show the grid. - * + * Represents a border with zany triangles design. * @remarks * [Api set: WordApiDesktop 1.3] */ - showGrid: boolean; + zanyTriangles = "ZanyTriangles", /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. - * + * Represents a border with pyramids design. * @remarks * [Api set: WordApiDesktop 1.3] */ - suppressEndnotes: boolean; + pyramids = "Pyramids", /** - * Specifies the top margin of the page in points. - * + * Represents a border with pyramids above design. * @remarks * [Api set: WordApiDesktop 1.3] */ - topMargin: number; + pyramidsAbove = "PyramidsAbove", /** - * Specifies whether to print two pages per sheet. - * + * Represents a border with gray confetti design. * @remarks * [Api set: WordApiDesktop 1.3] */ - twoPagesOnOne: boolean; + confettiGrays = "ConfettiGrays", /** - * Specifies the vertical alignment of text on each page in a document or section. - * + * Represents a border with outline confetti design. * @remarks * [Api set: WordApiDesktop 1.3] */ - verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + confettiOutline = "ConfettiOutline", /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents a border with white confetti design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.PageSetup): void; + confettiWhite = "ConfettiWhite", /** - * Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. - * + * Represents a border with mosaic design. * @remarks * [Api set: WordApiDesktop 1.3] */ - setAsTemplateDefault(): void; + mosaic = "Mosaic", /** - * Switches between portrait and landscape page orientations for a document or section. - * + * Represents a border with lightning design (variant 2). * @remarks * [Api set: WordApiDesktop 1.3] */ - togglePortrait(): void; + lightning2 = "Lightning2", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents a border with heebie jeebies design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup; + heebieJeebies = "HeebieJeebies", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Represents a border with light bulb design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNames?: string | string[]): Word.PageSetup; + lightBulb = "LightBulb", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Represents a border with gradient design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.PageSetup; + gradient = "Gradient", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with triangle party design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - track(): Word.PageSetup; + triangleParty = "TriangleParty", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with twisted lines design (variant 2). + * @remarks + * [Api set: WordApiDesktop 1.3] */ - untrack(): Word.PageSetup; - /** - * 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.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.PageSetupData; - } - /** - * Represents line numbers in the left margin or to the left of each newspaper-style column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class LineNumbering extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + twistedLines2 = "TwistedLines2", /** - * Specifies the numeric increment for line numbers. - * + * Represents a border with moons design. * @remarks * [Api set: WordApiDesktop 1.3] */ - countBy: number; + moons = "Moons", /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. - * + * Represents a border with ovals design. * @remarks * [Api set: WordApiDesktop 1.3] */ - distanceFromText: number; + ovals = "Ovals", /** - * Specifies if line numbering is active for the specified document, section, or sections. - * + * Represents a border with double diamonds design. * @remarks * [Api set: WordApiDesktop 1.3] */ - isActive: boolean; + doubleDiamonds = "DoubleDiamonds", /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. - * + * Represents a border with chain link design. * @remarks * [Api set: WordApiDesktop 1.3] */ - restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + chainLink = "ChainLink", /** - * Specifies the starting line number. - * + * Represents a border with triangles design. * @remarks * [Api set: WordApiDesktop 1.3] */ - startingNumber: number; - /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.LineNumberingUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LineNumbering): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: Word.Interfaces.LineNumberingLoadOptions): Word.LineNumbering; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.LineNumbering; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.LineNumbering; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.LineNumbering; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.LineNumbering; - /** - * 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.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.LineNumberingData; - } - /** - * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class TextColumnCollection extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; - /** Gets the loaded child items in this collection. */ - readonly items: Word.TextColumn[]; + triangles = "Triangles", /** - * Returns a `TextColumn` object that represents a new text column added to a section or document. - * + * Represents a border with tribal design (variant 1). * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param options Optional. Options for configuring the new text column. - * @returns A `TextColumn` object that represents a new text column added to the document. */ - add(options?: Word.TextColumnAddOptions): Word.TextColumn; + tribal1 = "Tribal1", /** - * Gets the direction in which text flows from one text column to the next. - * + * Represents a border with marquee toothed design. * @remarks * [Api set: WordApiDesktop 1.3] */ - getFlowDirection(): OfficeExtension.ClientResult; + marqueeToothed = "MarqueeToothed", /** - * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. - * + * Represents a border with sharks teeth design. * @remarks * [Api set: WordApiDesktop 1.3] */ - getHasLineBetween(): OfficeExtension.ClientResult; + sharksTeeth = "SharksTeeth", /** - * Gets whether text columns are evenly spaced. - * + * Represents a border with sawtooth design. * @remarks * [Api set: WordApiDesktop 1.3] */ - getIsEvenlySpaced(): OfficeExtension.ClientResult; + sawtooth = "Sawtooth", /** - * Arranges text into the specified number of text columns. - * + * Represents a border with gray sawtooth design. * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param numColumns The number of columns the text is to be arranged into. */ - setCount(numColumns: number): void; + sawtoothGray = "SawtoothGray", /** - * Sets the direction in which text flows from one text column to the next. - * + * Represents a border with postage stamp design. * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param value The flow direction to set. */ - setFlowDirection(value: Word.FlowDirection): void; + postageStamp = "PostageStamp", /** - * Sets the direction in which text flows from one text column to the next. - * + * Represents a border with weaving strips design. * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param value The flow direction to set. */ - setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; + weavingStrips = "WeavingStrips", /** - * Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object. - * + * Represents a border with zigzag design. * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param value `true` to show vertical lines between columns. */ - setHasLineBetween(value: boolean): void; + zigZag = "ZigZag", /** - * Sets whether text columns are evenly spaced. - * + * Represents a border with cross stitch design. * @remarks * [Api set: WordApiDesktop 1.3] - * - * @param value `true` to evenly space all the text columns in the document. - */ - setIsEvenlySpaced(value: boolean): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. - */ - load(options?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.TextColumnCollection; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. - */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TextColumnCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TextColumnCollection; + crossStitch = "CrossStitch", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with gems design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - untrack(): Word.TextColumnCollection; - /** - * 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.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.TextColumnCollectionData; - } - /** - * Represents options for a new text column in a document or section of a document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface TextColumnAddOptions { + gems = "Gems", /** - * If provided, specifies whether to evenly space all the text columns in the document. The default value is `true`. - * + * Represents a border with circles and rectangles design. * @remarks * [Api set: WordApiDesktop 1.3] */ - isEvenlySpaced?: boolean; + circlesRectangles = "CirclesRectangles", /** - * If provided, specifies the spacing between the text columns in the document, in points. - The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. - * + * Represents a border with corner triangles design. * @remarks * [Api set: WordApiDesktop 1.3] */ - spacing?: number; + cornerTriangles = "CornerTriangles", /** - * If provided, specifies the width of the new text column in the document, in points. - The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. - * + * Represents a border with insects creatures design. * @remarks * [Api set: WordApiDesktop 1.3] */ - width?: number; - } - /** - * Represents a single text column in a section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - class TextColumn extends OfficeExtension.ClientObject { - /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + creaturesInsects = "CreaturesInsects", /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. - * + * Represents a border with zigzag stitch design. * @remarks * [Api set: WordApiDesktop 1.3] */ - spaceAfter: number; + zigZagStitch = "ZigZagStitch", /** - * Specifies the width, in points, of the specified text columns. - * + * Represents a border with checkered design. * @remarks * [Api set: WordApiDesktop 1.3] */ - width: number; + checkered = "Checkered", /** - * 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. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents a border with black checked bar design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - set(properties: Interfaces.TextColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TextColumn): void; + checkedBarBlack = "CheckedBarBlack", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param options Provides options for which properties of the object to load. + * Represents a border with marquee design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(options?: Word.Interfaces.TextColumnLoadOptions): Word.TextColumn; + marquee = "Marquee", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * Represents a border with basic white dots design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNames?: string | string[]): Word.TextColumn; + basicWhiteDots = "BasicWhiteDots", /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. - * - * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + * Represents a border with basic wide midline design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TextColumn; + basicWideMidline = "BasicWideMidline", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with basic wide outline design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - track(): Word.TextColumn; + basicWideOutline = "BasicWideOutline", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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. + * Represents a border with basic wide inline design. + * @remarks + * [Api set: WordApiDesktop 1.3] */ - untrack(): Word.TextColumn; - /** - * 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.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.TextColumnData; - } - /** - * Specifies the case of the text in the specified range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum CharacterCase { + basicWideInline = "BasicWideInline", /** - * Specifies the next case. + * Represents a border with basic thin lines design. * @remarks * [Api set: WordApiDesktop 1.3] */ - next = "Next", + basicThinLines = "BasicThinLines", /** - * Specifies lowercase. + * Represents a border with basic white dashes design. * @remarks * [Api set: WordApiDesktop 1.3] */ - lower = "Lower", + basicWhiteDashes = "BasicWhiteDashes", /** - * Specifies uppercase. + * Represents a border with basic white squares design. * @remarks * [Api set: WordApiDesktop 1.3] */ - upper = "Upper", + basicWhiteSquares = "BasicWhiteSquares", /** - * Specifies title case for each word. + * Represents a border with basic black squares design. * @remarks * [Api set: WordApiDesktop 1.3] */ - titleWord = "TitleWord", + basicBlackSquares = "BasicBlackSquares", /** - * Specifies title case for the sentence. + * Represents a border with basic black dashes design. * @remarks * [Api set: WordApiDesktop 1.3] */ - titleSentence = "TitleSentence", + basicBlackDashes = "BasicBlackDashes", /** - * Specifies toggle case. + * Represents a border with basic black dots design. * @remarks * [Api set: WordApiDesktop 1.3] */ - toggle = "Toggle", + basicBlackDots = "BasicBlackDots", /** - * Specifies half-width characters. + * Represents a border with top stars design. * @remarks * [Api set: WordApiDesktop 1.3] */ - halfWidth = "HalfWidth", + starsTop = "StarsTop", /** - * Specifies full-width characters. + * Represents a border with certificate banner design. * @remarks * [Api set: WordApiDesktop 1.3] */ - fullWidth = "FullWidth", + certificateBanner = "CertificateBanner", /** - * Specifies Katakana characters. + * Represents a border with handmade design (variant 1). * @remarks * [Api set: WordApiDesktop 1.3] */ - katakana = "Katakana", + handmade1 = "Handmade1", /** - * Specifies Hiragana characters. + * Represents a border with handmade design (variant 2). * @remarks * [Api set: WordApiDesktop 1.3] */ - hiragana = "Hiragana", - } - /** - * Specifies the character width of the text in the specified range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum CharacterWidth { + handmade2 = "Handmade2", /** - * Specifies half-width characters. + * Represents a border with torn paper design. * @remarks * [Api set: WordApiDesktop 1.3] */ - half = "Half", + tornPaper = "TornPaper", /** - * Specifies full-width characters. + * Represents a border with black torn paper design. * @remarks * [Api set: WordApiDesktop 1.3] */ - full = "Full", - } - /** - * Specifies the direction in which text flows from one text column to the next. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum FlowDirection { + tornPaperBlack = "TornPaperBlack", /** - * Text flows from left to right. + * Represents a border with coupon cutout dashes design. * @remarks * [Api set: WordApiDesktop 1.3] */ - leftToRight = "LeftToRight", + couponCutoutDashes = "CouponCutoutDashes", /** - * Text flows from right to left. + * Represents a border with coupon cutout dots design. * @remarks * [Api set: WordApiDesktop 1.3] */ - rightToLeft = "RightToLeft", + couponCutoutDots = "CouponCutoutDots", } /** - * Specifies where the gutter appears in the document. + * Specifies the preferred unit of measure to use when measuring the width of an item. * * @remarks * [Api set: WordApiDesktop 1.3] */ - enum GutterPosition { + enum PreferredWidthType { /** - * The gutter appears on the left side of the document. + * Automatically select the unit of measure to use based on the current selection. * @remarks * [Api set: WordApiDesktop 1.3] */ - left = "Left", + auto = "Auto", /** - * The gutter appears on the right side of the document. + * Measure the current item width using a specified percentage. * @remarks * [Api set: WordApiDesktop 1.3] */ - right = "Right", + percent = "Percent", /** - * The gutter appears at the top of the document. + * Measure the current item width using a specified number of points. * @remarks * [Api set: WordApiDesktop 1.3] */ - top = "Top", + points = "Points", } /** - * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. + * Specifies the way Word adjusts the table when the left indent is changed. * * @remarks * [Api set: WordApiDesktop 1.3] */ - enum GutterStyle { + enum RulerStyle { /** - * Gutter style for bidirectional text flow. This is mainly right to left. + * Adjusts the left edge of row or rows, preserving the width of all columns by shifting them to the left or right. This is the default value. * @remarks * [Api set: WordApiDesktop 1.3] */ - bidirectional = "Bidirectional", + none = "None", /** - * Gutter style for Latin text flow. This is mainly left to right. + * Adjusts the left edge of the first column, preserving the position of the right edge of the table by proportionally adjusting the widths of all the cells in the specified row or rows. * @remarks * [Api set: WordApiDesktop 1.3] */ - latin = "Latin", + proportional = "Proportional", + /** + * Adjusts the left edge of the first column only, preserving the positions of the other columns and the right edge of the table. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + firstColumn = "FirstColumn", + /** + * Adjusts the left edge of the first column, preserving the position of the right edge of the table by setting the widths of all the cells in the specified row or rows to the same value. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sameWidth = "SameWidth", } /** - * Specifies how text is laid out in the layout mode for the current document. + * Represents the East Asian language to use when breaking lines of text in the specified document or template. * * @remarks * [Api set: WordApiDesktop 1.3] */ - enum LayoutMode { + enum FarEastLineBreakLanguageId { /** - * Default layout mode. + * Represents Traditional Chinese language. * @remarks * [Api set: WordApiDesktop 1.3] */ - default = "Default", + traditionalChinese = "TraditionalChinese", /** - * Grid layout mode. + * Represents Japanese language. * @remarks * [Api set: WordApiDesktop 1.3] */ - grid = "Grid", + japanese = "Japanese", /** - * Line grid layout mode. + * Represents Korean language. * @remarks * [Api set: WordApiDesktop 1.3] */ - lineGrid = "LineGrid", + korean = "Korean", /** - * Genko layout mode. + * Represents Simplified Chinese language. * @remarks * [Api set: WordApiDesktop 1.3] */ - genko = "Genko", + simplifiedChinese = "SimplifiedChinese", } /** - * Specifies the numbering rule to apply. + * Represents the level of line breaking to use for East Asian languages in the specified document or template. * * @remarks * [Api set: WordApiDesktop 1.3] */ - enum NumberingRule { + enum FarEastLineBreakLevel { /** - * Restart numbering continuously. + * Represents the normal line break level. * @remarks * [Api set: WordApiDesktop 1.3] */ - restartContinuous = "RestartContinuous", + normal = "Normal", /** - * Restart numbering at the beginning of each section. + * Represents the strict line break level. * @remarks * [Api set: WordApiDesktop 1.3] */ - restartSection = "RestartSection", + strict = "Strict", /** - * Restart numbering at the beginning of each page. + * Represents the custom line break level. * @remarks * [Api set: WordApiDesktop 1.3] */ - restartPage = "RestartPage", + custom = "Custom", } /** - * Specifies a page layout orientation. + * Specifies the character spacing adjustment for a document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - enum PageOrientation { + enum JustificationMode { /** - * Portrait orientation. + * Expands the character spacing * @remarks * [Api set: WordApiDesktop 1.3] */ - portrait = "Portrait", + expand = "Expand", /** - * Landscape orientation. + * Compresses the character spacing. * @remarks * [Api set: WordApiDesktop 1.3] */ - landscape = "Landscape", + compress = "Compress", + /** + * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + compressKana = "CompressKana", } /** - * Specifies the type of vertical alignment to apply. + * Specifies the type of template. * * @remarks * [Api set: WordApiDesktop 1.3] */ - enum PageSetupVerticalAlignment { - /** - * Align text to the top. - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - top = "Top", + enum TemplateType { /** - * Align text to the center. + * Represents the normal template type. * @remarks * [Api set: WordApiDesktop 1.3] */ - center = "Center", + normal = "Normal", /** - * Justify text vertically. + * Represents the global template type. * @remarks * [Api set: WordApiDesktop 1.3] */ - justify = "Justify", + global = "Global", /** - * Align text to the bottom. + * Represents the attached template type. * @remarks * [Api set: WordApiDesktop 1.3] */ - bottom = "Bottom", + attached = "Attached", } /** - * Specifies a paper size. + * Represents the language ID of a Word document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - enum PaperSize { + enum LanguageId { /** - * 10x14 paper size. + * Afrikaans language. * @remarks * [Api set: WordApiDesktop 1.3] */ - size10x14 = "Size10x14", + afrikaans = "Afrikaans", /** - * 11x17 paper size. + * Albanian language. * @remarks * [Api set: WordApiDesktop 1.3] */ - size11x17 = "Size11x17", + albanian = "Albanian", /** - * Letter paper size. + * Amharic language. * @remarks * [Api set: WordApiDesktop 1.3] */ - letter = "Letter", + amharic = "Amharic", /** - * Small letter paper size. + * Arabic language. * @remarks * [Api set: WordApiDesktop 1.3] */ - letterSmall = "LetterSmall", + arabic = "Arabic", /** - * Legal paper size. + * Arabic Algerian language. * @remarks * [Api set: WordApiDesktop 1.3] */ - legal = "Legal", + arabicAlgeria = "ArabicAlgeria", /** - * Executive paper size. + * Arabic Bahraini language. * @remarks * [Api set: WordApiDesktop 1.3] */ - executive = "Executive", + arabicBahrain = "ArabicBahrain", /** - * A3 paper size. + * Arabic Egyptian language. * @remarks * [Api set: WordApiDesktop 1.3] */ - a3 = "A3", + arabicEgypt = "ArabicEgypt", /** - * A4 paper size. + * Arabic Iraqi language. * @remarks * [Api set: WordApiDesktop 1.3] */ - a4 = "A4", + arabicIraq = "ArabicIraq", /** - * Small A4 paper size. + * Arabic Jordanian language. * @remarks * [Api set: WordApiDesktop 1.3] */ - a4Small = "A4Small", + arabicJordan = "ArabicJordan", /** - * A5 paper size. + * Arabic Kuwaiti language. * @remarks * [Api set: WordApiDesktop 1.3] */ - a5 = "A5", + arabicKuwait = "ArabicKuwait", /** - * B4 paper size. + * Arabic Lebanese language. * @remarks * [Api set: WordApiDesktop 1.3] */ - b4 = "B4", + arabicLebanon = "ArabicLebanon", /** - * B5 paper size. + * Arabic Libyan language. * @remarks * [Api set: WordApiDesktop 1.3] */ - b5 = "B5", + arabicLibya = "ArabicLibya", /** - * C-sheet paper size. + * Arabic Moroccan language. * @remarks * [Api set: WordApiDesktop 1.3] */ - csheet = "CSheet", + arabicMorocco = "ArabicMorocco", /** - * D-sheet paper size. + * Arabic Omani language. * @remarks * [Api set: WordApiDesktop 1.3] */ - dsheet = "DSheet", + arabicOman = "ArabicOman", /** - * E-sheet paper size. + * Arabic Qatari language. * @remarks * [Api set: WordApiDesktop 1.3] */ - esheet = "ESheet", + arabicQatar = "ArabicQatar", /** - * Fanfold legal German paper size. + * Arabic Syrian language. * @remarks * [Api set: WordApiDesktop 1.3] */ - fanfoldLegalGerman = "FanfoldLegalGerman", + arabicSyria = "ArabicSyria", /** - * Fanfold standard German paper size. + * Arabic Tunisian language. * @remarks * [Api set: WordApiDesktop 1.3] */ - fanfoldStdGerman = "FanfoldStdGerman", + arabicTunisia = "ArabicTunisia", /** - * Fanfold US paper size. + * Arabic United Arab Emirates language. * @remarks * [Api set: WordApiDesktop 1.3] */ - fanfoldUS = "FanfoldUS", + arabicUAE = "ArabicUAE", /** - * Folio paper size. + * Arabic Yemeni language. * @remarks * [Api set: WordApiDesktop 1.3] */ - folio = "Folio", + arabicYemen = "ArabicYemen", /** - * Ledger paper size. + * Armenian language. * @remarks * [Api set: WordApiDesktop 1.3] */ - ledger = "Ledger", + armenian = "Armenian", /** - * Note paper size. + * Assamese language. * @remarks * [Api set: WordApiDesktop 1.3] */ - note = "Note", + assamese = "Assamese", /** - * Quarto paper size. + * Azerbaijani Cyrillic language. * @remarks * [Api set: WordApiDesktop 1.3] */ - quarto = "Quarto", + azeriCyrillic = "AzeriCyrillic", /** - * Statement paper size. + * Azerbaijani Latin language. * @remarks * [Api set: WordApiDesktop 1.3] */ - statement = "Statement", + azeriLatin = "AzeriLatin", /** - * Tabloid paper size. + * Basque (Basque). * @remarks * [Api set: WordApiDesktop 1.3] */ - tabloid = "Tabloid", + basque = "Basque", /** - * Envelope size 9. + * Belgian Dutch language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelope9 = "Envelope9", + belgianDutch = "BelgianDutch", /** - * Envelope size 10. + * Belgian French language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelope10 = "Envelope10", + belgianFrench = "BelgianFrench", /** - * Envelope size 11. + * Bengali language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelope11 = "Envelope11", + bengali = "Bengali", /** - * Envelope size 12. + * Bulgarian language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelope12 = "Envelope12", + bulgarian = "Bulgarian", /** - * Envelope size 14. + * Burmese language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelope14 = "Envelope14", + burmese = "Burmese", /** - * Envelope B4 size. + * Belarusian language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeB4 = "EnvelopeB4", + belarusian = "Belarusian", /** - * Envelope B5 size. + * Catalan language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeB5 = "EnvelopeB5", + catalan = "Catalan", /** - * Envelope B6 size. + * Cherokee language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeB6 = "EnvelopeB6", + cherokee = "Cherokee", /** - * Envelope C3 size. + * Chinese Hong Kong SAR language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeC3 = "EnvelopeC3", + chineseHongKongSAR = "ChineseHongKongSAR", /** - * Envelope C4 size. + * Chinese Macao SAR language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeC4 = "EnvelopeC4", + chineseMacaoSAR = "ChineseMacaoSAR", /** - * Envelope C5 size. + * Chinese Singapore language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeC5 = "EnvelopeC5", + chineseSingapore = "ChineseSingapore", /** - * Envelope C6 size. + * Croatian language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeC6 = "EnvelopeC6", + croatian = "Croatian", /** - * Envelope C65 size. + * Czech language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeC65 = "EnvelopeC65", + czech = "Czech", /** - * Envelope DL size. + * Danish language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeDL = "EnvelopeDL", + danish = "Danish", /** - * Envelope Italy size. + * Divehi language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeItaly = "EnvelopeItaly", + divehi = "Divehi", /** - * Envelope Monarch size. + * Dutch language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopeMonarch = "EnvelopeMonarch", + dutch = "Dutch", /** - * Envelope Personal size. + * Edo language. * @remarks * [Api set: WordApiDesktop 1.3] */ - envelopePersonal = "EnvelopePersonal", + edo = "Edo", /** - * Custom paper size. + * Australian English language. * @remarks * [Api set: WordApiDesktop 1.3] */ - custom = "Custom", - } - /** - * Specifies how Word displays the reading order and alignment for the specified sections. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum SectionDirection { + englishAUS = "EnglishAUS", /** - * Right-to-left reading order. + * Belize English language. * @remarks * [Api set: WordApiDesktop 1.3] */ - rightToLeft = "RightToLeft", + englishBelize = "EnglishBelize", /** - * Left-to-right reading order. + * Canadian English language. * @remarks * [Api set: WordApiDesktop 1.3] */ - leftToRight = "LeftToRight", - } - /** - * Specifies the type of section break for the specified item. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - enum SectionStart { + englishCanadian = "EnglishCanadian", /** - * Continuous section break. + * Caribbean English language. * @remarks * [Api set: WordApiDesktop 1.3] */ - continuous = "Continuous", + englishCaribbean = "EnglishCaribbean", /** - * New column section break. + * Indonesian English language. * @remarks * [Api set: WordApiDesktop 1.3] */ - newColumn = "NewColumn", + englishIndonesia = "EnglishIndonesia", /** - * New page section break. + * Irish English language. * @remarks * [Api set: WordApiDesktop 1.3] */ - newPage = "NewPage", + englishIreland = "EnglishIreland", /** - * Even page section break. + * Jamaican English language. * @remarks * [Api set: WordApiDesktop 1.3] */ - evenPage = "EvenPage", + englishJamaica = "EnglishJamaica", /** - * Odd page section break. + * New Zealand English language. * @remarks * [Api set: WordApiDesktop 1.3] */ - oddPage = "OddPage", - } - enum ErrorCodes { - accessDenied = "AccessDenied", - generalException = "GeneralException", - invalidArgument = "InvalidArgument", - itemNotFound = "ItemNotFound", - notAllowed = "NotAllowed", - notImplemented = "NotImplemented", - searchDialogIsOpen = "SearchDialogIsOpen", - searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", - } - namespace Interfaces { + englishNewZealand = "EnglishNewZealand", /** - * Provides ways to load properties of only a subset of members of a collection. - */ - interface CollectionLoadOptions { - /** - * Specify the number of items in the queried collection to be included in the result. - */ - $top?: number; - /** - * Specify the number of items in the collection that are to be skipped and not included in the result. If `top` is specified, the selection of result will start after skipping the specified number of items. - */ - $skip?: number; - } - /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ - interface AnnotationCollectionUpdateData { - items?: Word.Interfaces.AnnotationData[]; - } - /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ - interface ApplicationUpdateData { - /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - bibliography?: Word.Interfaces.BibliographyUpdateData; - /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - checkLanguage?: boolean; - } - /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ - interface BodyUpdateData { - /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontUpdateData; - /** - * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. - * - * @remarks - * [Api set: WordApi 1.1] - */ - style?: string; - /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. - * - * @remarks - * [Api set: WordApi 1.3] - */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - } - /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ - interface BorderUpdateData { - /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - color?: string; - /** - * Specifies the border type for the border. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; - /** - * Specifies whether the border is visible. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - visible?: boolean; + * Filipino English language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + englishPhilippines = "EnglishPhilippines", + /** + * South African English language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + englishSouthAfrica = "EnglishSouthAfrica", + /** + * Tobago Trinidad English language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + englishTrinidadTobago = "EnglishTrinidadTobago", + /** + * United Kingdom English language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + englishUK = "EnglishUK", + /** + * United States English language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + englishUS = "EnglishUS", + /** + * Zimbabwe English language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + englishZimbabwe = "EnglishZimbabwe", + /** + * Estonian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + estonian = "Estonian", + /** + * Faeroese language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + faeroese = "Faeroese", + /** + * Filipino language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + filipino = "Filipino", + /** + * Finnish language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + finnish = "Finnish", + /** + * French language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + french = "French", + /** + * French Cameroon language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchCameroon = "FrenchCameroon", + /** + * French Canadian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchCanadian = "FrenchCanadian", + /** + * French (Congo (DRC)) language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchCongoDRC = "FrenchCongoDRC", + /** + * French Cote d'Ivoire language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchCotedIvoire = "FrenchCotedIvoire", + /** + * French Haiti language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchHaiti = "FrenchHaiti", + /** + * French Luxembourg language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchLuxembourg = "FrenchLuxembourg", + /** + * French Mali language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchMali = "FrenchMali", + /** + * French Monaco language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchMonaco = "FrenchMonaco", + /** + * French Morocco language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchMorocco = "FrenchMorocco", + /** + * French Reunion language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchReunion = "FrenchReunion", + /** + * French Senegal language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchSenegal = "FrenchSenegal", + /** + * French West Indies language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frenchWestIndies = "FrenchWestIndies", + /** + * Frisian Netherlands language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frisianNetherlands = "FrisianNetherlands", + /** + * Fulfulde language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fulfulde = "Fulfulde", + /** + * Irish (Irish) language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gaelicIreland = "GaelicIreland", + /** + * Scottish Gaelic language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gaelicScotland = "GaelicScotland", + /** + * Galician language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + galician = "Galician", + /** + * Georgian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + georgian = "Georgian", + /** + * German language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + german = "German", + /** + * German Austrian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + germanAustria = "GermanAustria", + /** + * German Liechtenstein language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + germanLiechtenstein = "GermanLiechtenstein", + /** + * German Luxembourg language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + germanLuxembourg = "GermanLuxembourg", + /** + * Greek language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + greek = "Greek", + /** + * Guarani language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + guarani = "Guarani", + /** + * Gujarati language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gujarati = "Gujarati", + /** + * Hausa language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hausa = "Hausa", + /** + * Hawaiian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hawaiian = "Hawaiian", + /** + * Hebrew language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hebrew = "Hebrew", + /** + * Hindi language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hindi = "Hindi", + /** + * Hungarian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hungarian = "Hungarian", + /** + * Ibibio language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + ibibio = "Ibibio", + /** + * Icelandic language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + icelandic = "Icelandic", + /** + * Igbo language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + igbo = "Igbo", + /** + * Indonesian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + indonesian = "Indonesian", + /** + * Inuktitut language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + inuktitut = "Inuktitut", + /** + * Italian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + italian = "Italian", + /** + * Japanese language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + japanese = "Japanese", + /** + * Kannada language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + kannada = "Kannada", + /** + * Kanuri language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + kanuri = "Kanuri", + /** + * Kashmiri language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + kashmiri = "Kashmiri", + /** + * Kazakh language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + kazakh = "Kazakh", + /** + * Khmer language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + khmer = "Khmer", + /** + * Kirghiz language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + kirghiz = "Kirghiz", + /** + * Konkani language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + konkani = "Konkani", + /** + * Korean language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + korean = "Korean", + /** + * Kyrgyz language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + kyrgyz = "Kyrgyz", + /** + * No specified language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageNone = "LanguageNone", + /** + * Lao language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lao = "Lao", + /** + * Latin language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + latin = "Latin", + /** + * Latvian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + latvian = "Latvian", + /** + * Lithuanian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lithuanian = "Lithuanian", + /** + * Macedonian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + macedonianFYROM = "MacedonianFYROM", + /** + * Malayalam language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + malayalam = "Malayalam", + /** + * Malay Brunei Darussalam language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + malayBruneiDarussalam = "MalayBruneiDarussalam", + /** + * Malaysian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + malaysian = "Malaysian", + /** + * Maltese language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + maltese = "Maltese", + /** + * Manipuri language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + manipuri = "Manipuri", + /** + * Marathi language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + marathi = "Marathi", + /** + * Mexican Spanish language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mexicanSpanish = "MexicanSpanish", + /** + * Mongolian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mongolian = "Mongolian", + /** + * Nepali language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nepali = "Nepali", + /** + * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + noProofing = "NoProofing", + /** + * Norwegian Bokmol language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + norwegianBokmol = "NorwegianBokmol", + /** + * Norwegian Nynorsk language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + norwegianNynorsk = "NorwegianNynorsk", + /** + * Odia (Oriya) language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + oriya = "Oriya", + /** + * Oromo language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + oromo = "Oromo", + /** + * Pashto language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pashto = "Pashto", + /** + * Persian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + persian = "Persian", + /** + * Polish language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + polish = "Polish", + /** + * Portuguese language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + portuguese = "Portuguese", + /** + * Portuguese (Brazil) language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + portugueseBrazil = "PortugueseBrazil", + /** + * Punjabi language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + punjabi = "Punjabi", + /** + * Rhaeto Romanic language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rhaetoRomanic = "RhaetoRomanic", + /** + * Romanian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + romanian = "Romanian", + /** + * Romanian Moldova language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + romanianMoldova = "RomanianMoldova", + /** + * Russian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + russian = "Russian", + /** + * Russian Moldova language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + russianMoldova = "RussianMoldova", + /** + * Sami Lappish language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + samiLappish = "SamiLappish", + /** + * Sanskrit language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sanskrit = "Sanskrit", + /** + * Serbian Cyrillic language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + serbianCyrillic = "SerbianCyrillic", + /** + * Serbian Latin language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + serbianLatin = "SerbianLatin", + /** + * Sesotho language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sesotho = "Sesotho", + /** + * Simplified Chinese language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + simplifiedChinese = "SimplifiedChinese", + /** + * Sindhi language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sindhi = "Sindhi", + /** + * Sindhi (Pakistan) language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sindhiPakistan = "SindhiPakistan", + /** + * Sinhalese language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sinhalese = "Sinhalese", + /** + * Slovakian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + slovak = "Slovak", + /** + * Slovenian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + slovenian = "Slovenian", + /** + * Somali language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + somali = "Somali", + /** + * Sorbian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sorbian = "Sorbian", + /** + * Spanish language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanish = "Spanish", + /** + * Spanish Argentina language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishArgentina = "SpanishArgentina", + /** + * Spanish Bolivian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishBolivia = "SpanishBolivia", + /** + * Spanish Chilean language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishChile = "SpanishChile", + /** + * Spanish Colombian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishColombia = "SpanishColombia", + /** + * Spanish Costa Rican language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishCostaRica = "SpanishCostaRica", + /** + * Spanish Dominican Republic language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishDominicanRepublic = "SpanishDominicanRepublic", + /** + * Spanish Ecuadorian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishEcuador = "SpanishEcuador", + /** + * Spanish El Salvadorian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishElSalvador = "SpanishElSalvador", + /** + * Spanish Guatemala language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishGuatemala = "SpanishGuatemala", + /** + * Spanish Honduran language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishHonduras = "SpanishHonduras", + /** + * Spanish Modern Sort language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishModernSort = "SpanishModernSort", + /** + * Spanish Nicaraguan language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishNicaragua = "SpanishNicaragua", + /** + * Spanish Panamanian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishPanama = "SpanishPanama", + /** + * Spanish Paraguayan language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishParaguay = "SpanishParaguay", + /** + * Spanish Peruvian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishPeru = "SpanishPeru", + /** + * Spanish Puerto Rican language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishPuertoRico = "SpanishPuertoRico", + /** + * Spanish Uruguayan language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishUruguay = "SpanishUruguay", + /** + * Spanish Venezuelan language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spanishVenezuela = "SpanishVenezuela", + /** + * Sutu language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sutu = "Sutu", + /** + * Swahili language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + swahili = "Swahili", + /** + * Swedish language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + swedish = "Swedish", + /** + * Swedish Finnish language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + swedishFinland = "SwedishFinland", + /** + * Swiss French language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + swissFrench = "SwissFrench", + /** + * Swiss German language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + swissGerman = "SwissGerman", + /** + * Swiss Italian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + swissItalian = "SwissItalian", + /** + * Syriac language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + syriac = "Syriac", + /** + * Tajik language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tajik = "Tajik", + /** + * Tamazight language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tamazight = "Tamazight", + /** + * Tamazight Latin language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tamazightLatin = "TamazightLatin", + /** + * Tamil language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tamil = "Tamil", + /** + * Tatar language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tatar = "Tatar", + /** + * Telugu language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + telugu = "Telugu", + /** + * Thai language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + thai = "Thai", + /** + * Tibetan language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tibetan = "Tibetan", + /** + * Tigrigna Eritrea language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tigrignaEritrea = "TigrignaEritrea", + /** + * Tigrigna Ethiopic language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tigrignaEthiopic = "TigrignaEthiopic", + /** + * Traditional Chinese language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + traditionalChinese = "TraditionalChinese", + /** + * Tsonga language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tsonga = "Tsonga", + /** + * Tswana language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tswana = "Tswana", + /** + * Turkish language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + turkish = "Turkish", + /** + * Turkmen language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + turkmen = "Turkmen", + /** + * Ukrainian language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + ukrainian = "Ukrainian", + /** + * Urdu language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + urdu = "Urdu", + /** + * Uzbek Cyrillic language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + uzbekCyrillic = "UzbekCyrillic", + /** + * Uzbek Latin language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + uzbekLatin = "UzbekLatin", + /** + * Venda language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + venda = "Venda", + /** + * Vietnamese language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + vietnamese = "Vietnamese", + /** + * Welsh language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + welsh = "Welsh", + /** + * Xhosa language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xhosa = "Xhosa", + /** + * Yi language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + yi = "Yi", + /** + * Yiddish language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + yiddish = "Yiddish", + /** + * Yoruba language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + yoruba = "Yoruba", + /** + * Zulu language. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + zulu = "Zulu", + } + /** + * Specifies how a building block is inserted into a document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum DocPartInsertType { + /** + * Inserts the content of the building block. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + content = "Content", + /** + * Inserts the building block as a paragraph. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + paragraph = "Paragraph", + /** + * Inserts the building block as a page. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + page = "Page", + } + /** + * Specifies the type of building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum BuildingBlockType { + /** + * Represents Quick Parts building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + quickParts = "QuickParts", + /** + * Represents Cover Page building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + coverPage = "CoverPage", + /** + * Represents Equations building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + equations = "Equations", + /** + * Represents Footers building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + footers = "Footers", + /** + * Represents Headers building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + headers = "Headers", + /** + * Represents Page Number building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageNumber = "PageNumber", + /** + * Represents Tables building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tables = "Tables", + /** + * Represents Watermarks building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + watermarks = "Watermarks", + /** + * Represents AutoText building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + autoText = "AutoText", + /** + * Represents Text Box building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textBox = "TextBox", + /** + * Represents Page Number Top building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageNumberTop = "PageNumberTop", + /** + * Represents Page Number Bottom building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageNumberBottom = "PageNumberBottom", + /** + * Represents Page Number Page building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageNumberPage = "PageNumberPage", + /** + * Represents Table of Contents building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tableOfContents = "TableOfContents", + /** + * Represents Custom Quick Parts building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customQuickParts = "CustomQuickParts", + /** + * Represents Custom Cover Page building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customCoverPage = "CustomCoverPage", + /** + * Represents Custom Equations building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customEquations = "CustomEquations", + /** + * Represents Custom Footers building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customFooters = "CustomFooters", + /** + * Represents Custom Headers building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customHeaders = "CustomHeaders", + /** + * Represents Custom Page Number building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customPageNumber = "CustomPageNumber", + /** + * Represents Custom Tables building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customTables = "CustomTables", + /** + * Represents Custom Watermarks building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customWatermarks = "CustomWatermarks", + /** + * Represents Custom AutoText building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customAutoText = "CustomAutoText", + /** + * Represents Custom Text Box building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customTextBox = "CustomTextBox", + /** + * Represents Custom Page Number Top building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customPageNumberTop = "CustomPageNumberTop", + /** + * Represents Custom Page Number Bottom building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customPageNumberBottom = "CustomPageNumberBottom", + /** + * Represents Custom Page Number Page building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customPageNumberPage = "CustomPageNumberPage", + /** + * Represents Custom Table of Contents building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customTableOfContents = "CustomTableOfContents", + /** + * Represents Custom building block type 1. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + custom1 = "Custom1", + /** + * Represents Custom building block type 2. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + custom2 = "Custom2", + /** + * Represents Custom building block type 3. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + custom3 = "Custom3", + /** + * Represents Custom building block type 4. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + custom4 = "Custom4", + /** + * Represents Custom building block type 5. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + custom5 = "Custom5", + /** + * Represents Bibliography building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bibliography = "Bibliography", + /** + * Represents Custom Bibliography building block type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customBibliography = "CustomBibliography", + } + /** + * Represents the type of a {@link Word.CustomXmlNode}. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum CustomXmlNodeType { + /** + * Represents an XML element node. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + element = "element", + /** + * Represents an XML attribute node. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + attribute = "attribute", + /** + * Represents an XML text node. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + text = "text", + /** + * Represents an XML CDATA section node. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + cData = "cData", + /** + * Represents an XML processing instruction node. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + processingInstruction = "processingInstruction", + /** + * Represents an XML comment node. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + comment = "comment", + /** + * Represents an XML document node. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + document = "document", + } + /** + * Specifies the type of link. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum LinkType { + /** + * OLE object. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + ole = "Ole", + /** + * Picture. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + picture = "Picture", + /** + * Text. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + text = "Text", + /** + * Reference library. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + reference = "Reference", + /** + * Include file. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + include = "Include", + /** + * Import file. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + import = "Import", + /** + * Dynamic Data Exchange. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + dde = "Dde", + /** + * Automatic DDE. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + ddeAuto = "DdeAuto", + /** + * Microsoft Excel chart. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + chart = "Chart", + } + /** + * Specifies the action associated with the verb that the OLE object should perform. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum OleVerb { + /** + * Performs the verb that is invoked when the user double-clicks the object. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + primary = "Primary", + /** + * Shows the object to the user for editing or viewing. Use it to show a newly inserted object for initial editing. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + show = "Show", + /** + * Opens the object in a separate window. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + open = "Open", + /** + * Removes the object's user interface from view. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + hide = "Hide", + /** + * Activates the object in place and displays any user-interface tools that the object needs, such as menus or toolbars. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + uiActivate = "UiActivate", + /** + * Runs the object and installs its window, but doesn't install any user-interface tools. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + inPlaceActivate = "InPlaceActivate", + /** + * Forces the object to discard any undo state that it might be maintaining; note that the object remains active, however. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + discardUndoState = "DiscardUndoState", + } + /** + * Represents the list formatting characteristics of a range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class ListFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly list: Word.List; + /** + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly listTemplate: Word.ListTemplate; + /** + * Indicates whether the `ListFormat` object contains a single list. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly isSingleList: boolean; + /** + * Indicates whether the `ListFormat` object contains a single list template. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly isSingleListTemplate: boolean; + /** + * Specifies the list level number for the first paragraph for the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listLevelNumber: number; + /** + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly listString: string; + /** + * Gets the type of the list for the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + /** + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly listValue: number; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListFormat): void; + /** + * Adds bullets and formatting to the paragraphs in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `word97`. + */ + applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; + /** + * Adds bullets and formatting to the paragraphs in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `word97`. + */ + applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + /** + * Applies a list template with a specific level to the paragraphs in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param listTemplate The list template to apply. + * @param options Optional. Options for applying the list template, such as whether to continue the previous list or which part of the list to apply the template to. + */ + applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; + /** + * Adds numbering and formatting to the paragraphs in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param defaultListBehavior Optional. Specifies the default list behavior. + */ + applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + /** + * Adds numbering and formatting to the paragraphs in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param defaultListBehavior Optional. Specifies the default list behavior. + */ + applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + /** + * Adds outline numbering and formatting to the paragraphs in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param defaultListBehavior Optional. Specifies the default list behavior. + */ + applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + /** + * Adds outline numbering and formatting to the paragraphs in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param defaultListBehavior Optional. Specifies the default list behavior. + */ + applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + /** + * Determines whether the `ListFormat` object can continue a previous list. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param listTemplate The list template to check. + * @returns A `Continue` value indicating whether continuation is possible. + */ + canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; + /** + * Converts numbers in the list to plain text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param numberType Optional. The type of number to convert. + */ + convertNumbersToText(numberType: Word.NumberType): void; + /** + * Converts numbers in the list to plain text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param numberType Optional. The type of number to convert. + */ + convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + /** + * Counts the numbered items in the list. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param options Optional. Options for counting numbered items, such as the type of number and the level to count. + * @returns The number of items. + */ + countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; + /** + * Indents the list by one level. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listIndent(): void; + /** + * Outdents the list by one level. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listOutdent(): void; + /** + * Removes numbering from the list. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param numberType Optional. The type of number to remove. + */ + removeNumbers(numberType: Word.NumberType): void; + /** + * Removes numbering from the list. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param numberType Optional. The type of number to remove. + */ + removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ListFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListFormat; + /** + * 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.ListFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListFormatData; + } + /** + * Represents options for counting numbered items in a range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface ListFormatCountNumberedItemsOptions { + /** + * If provided, specifies the level to count. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + level?: number; + /** + * If provided, specifies the type of number to count. The default value is `paragraph`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; + } + /** + * Represents options for applying a list template to a range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface ListTemplateApplyOptions { + /** + * If provided, specifies the level to apply in the list template. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + applyLevel?: number; + /** + * If provided, specifies which part of the list to apply the template to. The default value is `wholeList`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; + /** + * If provided, specifies whether to continue the previous list. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + continuePreviousList?: boolean; + /** + * If provided, specifies the default list behavior. The default value is `word97`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + defaultListBehavior?: Word.DefaultListBehavior | "Word97" | "Word2000" | "Word2002"; + } + /** + * Represents the fill formatting for a shape or text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class FillFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly backgroundColor: Word.ColorFormat; + /** + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly foregroundColor: Word.ColorFormat; + /** + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gradientAngle: number; + /** + * Gets the gradient color type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + /** + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly gradientDegree: number; + /** + * Returns the gradient style for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + /** + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly gradientVariant: number; + /** + * Specifies if the object, or the formatting applied to it, is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isVisible: boolean; + /** + * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + /** + * Returns the preset gradient type for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + /** + * Gets the preset texture. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + /** + * Specifies whether the fill rotates with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rotateWithObject: boolean; + /** + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + /** + * Specifies the horizontal scaling factor for the texture fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureHorizontalScale: number; + /** + * Returns the name of the custom texture file for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly textureName: string; + /** + * Specifies the horizontal offset of the texture from the origin in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureOffsetX: number; + /** + * Specifies the vertical offset of the texture. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureOffsetY: number; + /** + * Specifies whether the texture is tiled. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureTile: boolean; + /** + * Returns the texture type for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + /** + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureVerticalScale: number; + /** + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency: number; + /** + * Gets the fill format type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.FillFormat): void; + /** + * Sets the fill to a one-color gradient. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param style The gradient style. + * @param variant The gradient variant. Can be a value from 1 to 4. + * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). + */ + setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; + /** + * Sets the fill to a one-color gradient. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param style The gradient style. + * @param variant The gradient variant. Can be a value from 1 to 4. + * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). + */ + setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; + /** + * Sets the fill to a pattern. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setPatterned(pattern: Word.PatternType): void; + /** + * Sets the fill to a pattern. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void; + /** + * Sets the fill to a preset gradient. + The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; + /** + * Sets the fill to a preset gradient. + The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void; + /** + * Sets the fill to a preset texture. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setPresetTextured(presetTexture: Word.PresetTexture): void; + /** + * Sets the fill to a preset texture. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void; + /** + * Sets the fill to a two-color gradient. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setTwoColorGradient(style: Word.GradientStyle, variant: number): void; + /** + * Sets the fill to a two-color gradient. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; + /** + * Sets the fill to a uniform color. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + solid(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.FillFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.FillFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.FillFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.FillFormat; + /** + * 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.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.FillFormatData; + } + /** + * Represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class GlowFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly color: Word.ColorFormat; + /** + * Specifies the length of the radius for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + radius: number; + /** + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency: number; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.GlowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.GlowFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.GlowFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.GlowFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.GlowFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.GlowFormat; + /** + * 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.GlowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GlowFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.GlowFormatData; + } + /** + * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; + for a shape with a border, this object contains formatting information for the shape's border. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class LineFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly backgroundColor: Word.ColorFormat; + /** + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly foregroundColor: Word.ColorFormat; + /** + * Specifies the length of the arrowhead at the beginning of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + /** + * Specifies the style of the arrowhead at the beginning of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + /** + * Specifies the width of the arrowhead at the beginning of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + /** + * Specifies the dash style for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + /** + * Specifies the length of the arrowhead at the end of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + /** + * Specifies the style of the arrowhead at the end of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + /** + * Specifies the width of the arrowhead at the end of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + /** + * Specifies if to draw lines inside a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + insetPen: boolean; + /** + * Specifies if the object, or the formatting applied to it, is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isVisible: boolean; + /** + * Specifies the pattern applied to the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + /** + * Specifies the line format style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + /** + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency: number; + /** + * Specifies the thickness of the line in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + weight: number; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LineFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.LineFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.LineFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.LineFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.LineFormat; + /** + * 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.LineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.LineFormatData; + } + /** + * Represents the reflection formatting for a shape in Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class ReflectionFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + blur: number; + /** + * Specifies the amount of separation, in points, of the reflected image from the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + offset: number; + /** + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + size: number; + /** + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency: number; + /** + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ReflectionFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ReflectionFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ReflectionFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ReflectionFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ReflectionFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ReflectionFormat; + /** + * 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.ReflectionFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReflectionFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ReflectionFormatData; + } + /** + * Represents the color formatting of a shape or text in Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class ColorFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + brightness: number; + /** + * Specifies the theme color for a color format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + /** + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rgb: string; + /** + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tintAndShade: number; + /** + * Returns the shape color type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly type: Word.ColorType | "rgb" | "scheme"; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ColorFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ColorFormat): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ColorFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ColorFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ColorFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ColorFormat; + /** + * 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.ColorFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ColorFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ColorFormatData; + } + /** + * Represents the shadow formatting for a shape or text in Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class ShadowFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly foregroundColor: Word.ColorFormat; + /** + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + blur: number; + /** + * Specifies whether the object or the formatting applied to it is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isVisible: boolean; + /** + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + obscured: boolean; + /** + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + offsetX: number; + /** + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + offsetY: number; + /** + * Specifies whether to rotate the shadow when rotating the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rotateWithShape: boolean; + /** + * Specifies the width of the shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + size: number; + /** + * Specifies the type of shadow formatting to apply to a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + /** + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency: number; + /** + * Specifies the shape shadow type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShadowFormat): void; + /** + * Changes the horizontal offset of the shadow by the number of points. + Increment The number of points to adjust. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + incrementOffsetX(increment: number): void; + /** + * Changes the vertical offset of the shadow by the specified number of points. + Increment The number of points to adjust. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + incrementOffsetY(increment: number): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ShadowFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShadowFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ShadowFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ShadowFormat; + /** + * 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.ShadowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadowFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShadowFormatData; + } + /** + * Represents a shape's three-dimensional formatting. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class ThreeDimensionalFormat extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly contourColor: Word.ColorFormat; + /** + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly extrusionColor: Word.ColorFormat; + /** + * Specifies the depth of the bottom bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelBottomDepth: number; + /** + * Specifies the inset size for the bottom bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelBottomInset: number; + /** + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + /** + * Specifies the depth of the top bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelTopDepth: number; + /** + * Specifies the inset size for the top bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelTopInset: number; + /** + * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + /** + * Specifies the width of the contour of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + contourWidth: number; + /** + * Specifies the depth of the shape's extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + depth: number; + /** + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + /** + * Specifies the amount of perspective for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fieldOfView: number; + /** + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isPerspective: boolean; + /** + * Specifies if the specified object, or the formatting applied to it, is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isVisible: boolean; + /** + * Specifies the angle of the lighting. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lightAngle: number; + /** + * Returns a `PresetCamera` value that represents the camera presets. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + /** + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + /** + * Specifies a `LightRigType` value that represents the lighting preset. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + /** + * Specifies the position of the light source relative to the extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + /** + * Specifies the intensity of the extrusion lighting. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + /** + * Specifies the extrusion surface material. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + /** + * Returns the preset extrusion format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + /** + * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + projectText: boolean; + /** + * Specifies the rotation of the extruded shape around the x-axis in degrees. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rotationX: number; + /** + * Specifies the rotation of the extruded shape around the y-axis in degrees. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rotationY: number; + /** + * Specifies the z-axis rotation of the camera. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rotationZ: number; + /** + * Specifies the position on the z-axis for the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + z: number; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ThreeDimensionalFormat): void; + /** + * Horizontally rotates a shape on the x-axis. + The number of degrees to rotate. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + incrementRotationHorizontal(increment: number): void; + /** + * Vertically rotates a shape on the y-axis. + The number of degrees to rotate. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + incrementRotationVertical(increment: number): void; + /** + * Changes the rotation around the x-axis. + The number of degrees to rotate. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + incrementRotationX(increment: number): void; + /** + * Changes the rotation around the y-axis. + The number of degrees to rotate. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + incrementRotationY(increment: number): void; + /** + * Rotates a shape on the z-axis. + The number of degrees to rotate. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + incrementRotationZ(increment: number): void; + /** + * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + resetRotation(): void; + /** + * Sets the direction of the extrusion's sweep path. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param presetExtrusionDirection The preset direction. + */ + setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; + /** + * Sets the direction of the extrusion's sweep path. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param presetExtrusionDirection The preset direction. + */ + setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; + /** + * Sets the camera preset for the shape. + The preset camera type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setPresetCamera(presetCamera: Word.PresetCamera): void; + /** + * Sets the camera preset for the shape. + The preset camera type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void; + /** + * Sets the preset extrusion format. + The preset format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; + /** + * Sets the preset extrusion format. + The preset format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ThreeDimensionalFormat; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ThreeDimensionalFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ThreeDimensionalFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ThreeDimensionalFormat; + /** + * 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.ThreeDimensionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ThreeDimensionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ThreeDimensionalFormatData; + } + /** + * Specifies the length of the arrowhead at the end of a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ArrowheadLength { + /** + * Represents a mixed arrowhead length. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents a short arrowhead length. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + short = "Short", + /** + * Represents a medium arrowhead length. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + medium = "Medium", + /** + * Represents a long arrowhead length. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + long = "Long", + } + /** + * Specifies the style of the arrowhead at the end of a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ArrowheadStyle { + /** + * Represents a mixed arrowhead style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents no arrowhead. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + none = "None", + /** + * Represents a triangle arrowhead style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + triangle = "Triangle", + /** + * Represents an open arrowhead style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + open = "Open", + /** + * Represents a stealth arrowhead style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + stealth = "Stealth", + /** + * Represents a diamond arrowhead style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + diamond = "Diamond", + /** + * Represents an oval arrowhead style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + oval = "Oval", + } + /** + * Specifies the width of the arrowhead at the end of a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ArrowheadWidth { + /** + * Represents a mixed arrowhead width. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents a narrow arrowhead width. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + narrow = "Narrow", + /** + * Represents a medium arrowhead width. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + medium = "Medium", + /** + * Represents a wide arrowhead width. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + wide = "Wide", + } + /** + * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum BevelType { + /** + * Represents a mixed bevel type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "mixed", + /** + * Represents no bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + none = "none", + /** + * Represents a relaxed inset bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + relaxedInset = "relaxedInset", + /** + * Represents a circle bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + circle = "circle", + /** + * Represents a slope bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + slope = "slope", + /** + * Represents a cross bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + cross = "cross", + /** + * Represents an angle bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + angle = "angle", + /** + * Represents a soft round bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + softRound = "softRound", + /** + * Represents a convex bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + convex = "convex", + /** + * Represents a cool slant bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + coolSlant = "coolSlant", + /** + * Represents a divot bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + divot = "divot", + /** + * Represents a riblet bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + riblet = "riblet", + /** + * Represents a hard edge bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hardEdge = "hardEdge", + /** + * Represents an art deco bevel. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + artDeco = "artDeco", + } + /** + * Represents color index values in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ColorIndex { + /** + * Automatically determines the color. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + auto = "Auto", + /** + * Represents the color black. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + black = "Black", + /** + * Represents the color blue. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + blue = "Blue", + /** + * Represents the color turquoise. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + turquoise = "Turquoise", + /** + * Represents a bright green color. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + brightGreen = "BrightGreen", + /** + * Represents the color pink. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pink = "Pink", + /** + * Represents the color red. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + red = "Red", + /** + * Represents the color yellow. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + yellow = "Yellow", + /** + * Represents the color white. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + white = "White", + /** + * Represents a dark blue color. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + darkBlue = "DarkBlue", + /** + * Represents the color teal. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + teal = "Teal", + /** + * Represents the color green. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + green = "Green", + /** + * Represents the color violet. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + violet = "Violet", + /** + * Represents a dark red color. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + darkRed = "DarkRed", + /** + * Represents a dark yellow color. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + darkYellow = "DarkYellow", + /** + * Represents a gray color with 50% intensity. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gray50 = "Gray50", + /** + * Represents a gray color with 25% intensity. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gray25 = "Gray25", + /** + * Represents a classic red color. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + classicRed = "ClassicRed", + /** + * Represents a classic blue color. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + classicBlue = "ClassicBlue", + /** + * Represents a color determined by the author. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + byAuthor = "ByAuthor", + } + /** + * Specifies the color type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ColorType { + /** + * Represents an RGB color type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rgb = "rgb", + /** + * Represents a scheme color type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + scheme = "scheme", + } + /** + * Specifies whether the formatting from the previous list can be continued. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum Continue { + /** + * Formatting cannot continue from the previous list. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + disabled = "Disabled", + /** + * Formatting can continue from the previous list. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + list = "List", + /** + * Numbering can be restarted. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + reset = "Reset", + } + /** + * Specifies the default list behavior for a list. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum DefaultListBehavior { + /** + * Use formatting compatible with Microsoft Word 97. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + word97 = "Word97", + /** + * Use Web-oriented formatting as introduced in Microsoft Word 2000. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + word2000 = "Word2000", + /** + * Use formatting compatible with Microsoft Word 2002. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + word2002 = "Word2002", + } + /** + * Specifies the type of emphasis mark to use for a character or designated character string. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum EmphasisMark { + /** + * No emphasis mark. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + none = "None", + /** + * Emphasis mark over a solid circle. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + overSolidCircle = "OverSolidCircle", + /** + * Emphasis mark over a comma. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + overComma = "OverComma", + /** + * Emphasis mark over a white circle. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + overWhiteCircle = "OverWhiteCircle", + /** + * Emphasis mark under a solid circle. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + underSolidCircle = "UnderSolidCircle", + } + /** + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ExtrusionColorType { + /** + * Represents a mixed extrusion color type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "mixed", + /** + * Represents an automatic extrusion color based on the shape's fill. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + automatic = "automatic", + /** + * Represents a custom extrusion color independent of the shape's fill. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + custom = "custom", + } + /** + * Specifies a shape's fill type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum FillType { + /** + * Represents a mixed fill type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents a solid fill type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + solid = "Solid", + /** + * Represents a patterned fill type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + patterned = "Patterned", + /** + * Represents a gradient fill type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gradient = "Gradient", + /** + * Represents a textured fill type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textured = "Textured", + /** + * Represents a background fill type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + background = "Background", + /** + * Represents a picture fill type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + picture = "Picture", + } + /** + * Specifies the type of gradient used in a shape's fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum GradientColorType { + /** + * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Gradient with a single color and varying transparency or brightness. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + oneColor = "OneColor", + /** + * Gradient that blends two distinct colors. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + twoColors = "TwoColors", + /** + * Gradient that uses a predefined set of colors. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + presetColors = "PresetColors", + /** + * Gradient that includes more than two colors, often customized. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + multiColor = "MultiColor", + } + /** + * Specifies the style for a gradient fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum GradientStyle { + /** + * Represents a mixed gradient style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents a horizontal gradient style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + horizontal = "Horizontal", + /** + * Represents a vertical gradient style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + vertical = "Vertical", + /** + * Represents a diagonal-up gradient style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + diagonalUp = "DiagonalUp", + /** + * Represents a diagonal-down gradient style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + diagonalDown = "DiagonalDown", + /** + * Represents a gradient style from the corner. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fromCorner = "FromCorner", + /** + * Represents a gradient style from the title. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fromTitle = "FromTitle", + /** + * Represents a gradient style from the center. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fromCenter = "FromCenter", + } + /** + * Specifies the type of ligature applied to a font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum Ligature { + /** + * No ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + none = "None", + /** + * Standard ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + standard = "Standard", + /** + * Contextual ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + contextual = "Contextual", + /** + * Standard and contextual ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + standardContextual = "StandardContextual", + /** + * Historical ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + historical = "Historical", + /** + * Standard and historical ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + standardHistorical = "StandardHistorical", + /** + * Contextual and historical ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + contextualHistorical = "ContextualHistorical", + /** + * Standard, contextual, and historical ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + standardContextualHistorical = "StandardContextualHistorical", + /** + * Discretional ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + discretional = "Discretional", + /** + * Standard and discretional ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + standardDiscretional = "StandardDiscretional", + /** + * Contextual and discretional ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + contextualDiscretional = "ContextualDiscretional", + /** + * Standard, contextual, and discretional ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + standardContextualDiscretional = "StandardContextualDiscretional", + /** + * Historical and discretional ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + historicalDiscretional = "HistoricalDiscretional", + /** + * Standard, historical, and discretional ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + standardHistoricalDiscretional = "StandardHistoricalDiscretional", + /** + * Contextual, historical, and discretional ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", + /** + * All ligatures applied. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + all = "All", + } + /** + * Indicates the effects lighting for an object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum LightRigType { + /** + * Represents a mixed light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents legacy flat light rig type 1. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyFlat1 = "LegacyFlat1", + /** + * Represents legacy flat light rig type 2. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyFlat2 = "LegacyFlat2", + /** + * Represents legacy flat light rig type 3. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyFlat3 = "LegacyFlat3", + /** + * Represents legacy flat light rig type 4. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyFlat4 = "LegacyFlat4", + /** + * Represents legacy normal light rig type 1. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyNormal1 = "LegacyNormal1", + /** + * Represents legacy normal light rig type 2. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyNormal2 = "LegacyNormal2", + /** + * Represents legacy normal light rig type 3. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyNormal3 = "LegacyNormal3", + /** + * Represents legacy normal light rig type 4. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyNormal4 = "LegacyNormal4", + /** + * Represents legacy harsh light rig type 1. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyHarsh1 = "LegacyHarsh1", + /** + * Represents legacy harsh light rig type 2. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyHarsh2 = "LegacyHarsh2", + /** + * Represents legacy harsh light rig type 3. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyHarsh3 = "LegacyHarsh3", + /** + * Represents legacy harsh light rig type 4. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyHarsh4 = "LegacyHarsh4", + /** + * Represents a three-point light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + threePoint = "ThreePoint", + /** + * Represents a balanced light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + balanced = "Balanced", + /** + * Represents a soft light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + soft = "Soft", + /** + * Represents a harsh light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + harsh = "Harsh", + /** + * Represents a flood light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + flood = "Flood", + /** + * Represents a contrasting light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + contrasting = "Contrasting", + /** + * Represents a morning light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + morning = "Morning", + /** + * Represents a sunrise light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sunrise = "Sunrise", + /** + * Represents a sunset light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sunset = "Sunset", + /** + * Represents a chilly light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + chilly = "Chilly", + /** + * Represents a freezing light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + freezing = "Freezing", + /** + * Represents a flat light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + flat = "Flat", + /** + * Represents a two-point light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + twoPoint = "TwoPoint", + /** + * Represents a glow light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + glow = "Glow", + /** + * Represents a bright room light rig type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + brightRoom = "BrightRoom", + } + /** + * Specifies the dash style for a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum LineDashStyle { + /** + * Represents a mixed dash style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents a solid line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + solid = "Solid", + /** + * Represents a square dot line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + squareDot = "SquareDot", + /** + * Represents a round dot line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + roundDot = "RoundDot", + /** + * Represents a dashed line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dash = "Dash", + /** + * Represents a dash-dot line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dashDot = "DashDot", + /** + * Represents a dash-dot-dot line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dashDotDot = "DashDotDot", + /** + * Represents a long dash line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + longDash = "LongDash", + /** + * Represents a long dash-dot line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + longDashDot = "LongDashDot", + /** + * Represents a long dash-dot-dot line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + longDashDotDot = "LongDashDotDot", + /** + * Represents a system dash line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sysDash = "SysDash", + /** + * Represents a system dot line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sysDot = "SysDot", + /** + * Represents a system dash-dot line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sysDashDot = "SysDashDot", + } + /** + * Specifies the style for a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum LineFormatStyle { + /** + * Represents a mixed line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents a single line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + single = "Single", + /** + * Represents a thin-thin line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + thinThin = "ThinThin", + /** + * Represents a thin-thick line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + thinThick = "ThinThick", + /** + * Represents a thick-thin line style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + thickThin = "ThickThin", + /** + * Represents a thick line between two thin lines style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + thickBetweenThin = "ThickBetweenThin", + } + /** + * Specifies the portion of a list to which to apply a list template. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ListApplyTo { + /** + * Applies the list template to the entire list. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + wholeList = "WholeList", + /** + * Applies the list template from the cursor insertion point to the end of the list. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + thisPointForward = "ThisPointForward", + /** + * Applies the list template to the selection. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + selection = "Selection", + } + /** + * Represents the list type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ListType { + /** + * List with no bullets, numbering, or outlining. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listNoNumbering = "ListNoNumbering", + /** + * ListNum fields that can be used in the body of a paragraph. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listListNumOnly = "ListListNumOnly", + /** + * Bulleted list. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listBullet = "ListBullet", + /** + * Simple numeric list. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listSimpleNumbering = "ListSimpleNumbering", + /** + * Outlined list. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listOutlineNumbering = "ListOutlineNumbering", + /** + * Mixed numeric list. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listMixedNumbering = "ListMixedNumbering", + /** + * Picture bulleted list. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listPictureBullet = "ListPictureBullet", + } + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum NumberForm { + /** + * Default number form setting. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + default = "Default", + /** + * Lining number form setting. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lining = "Lining", + /** + * Old-style number form setting. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + oldStyle = "OldStyle", + } + /** + * Specifies the number spacing setting for an OpenType font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum NumberSpacing { + /** + * Default number spacing setting. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + default = "Default", + /** + * Proportional number spacing setting. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + proportional = "Proportional", + /** + * Tabular number spacing setting. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tabular = "Tabular", + } + /** + * Specifies the type of numbers in a list. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum NumberType { + /** + * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + paragraph = "Paragraph", + /** + * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listNum = "ListNum", + /** + * Default value for all other cases. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + allNumbers = "AllNumbers", + } + /** + * Specifies the fill pattern used in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PatternType { + /** + * Represents a mixed pattern type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents a 5 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent5 = "Percent5", + /** + * Represents a 10 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent10 = "Percent10", + /** + * Represents a 20 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent20 = "Percent20", + /** + * Represents a 25 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent25 = "Percent25", + /** + * Represents a 30 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent30 = "Percent30", + /** + * Represents a 40 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent40 = "Percent40", + /** + * Represents a 50 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent50 = "Percent50", + /** + * Represents a 60 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent60 = "Percent60", + /** + * Represents a 70 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent70 = "Percent70", + /** + * Represents a 75 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent75 = "Percent75", + /** + * Represents an 80 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent80 = "Percent80", + /** + * Represents a 90 percent fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + percent90 = "Percent90", + /** + * Represents a dark horizontal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + darkHorizontal = "DarkHorizontal", + /** + * Represents a dark vertical fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + darkVertical = "DarkVertical", + /** + * Represents a dark downward diagonal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + darkDownwardDiagonal = "DarkDownwardDiagonal", + /** + * Represents a dark upward diagonal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + darkUpwardDiagonal = "DarkUpwardDiagonal", + /** + * Represents a small checkerboard fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + smallCheckerBoard = "SmallCheckerBoard", + /** + * Represents a trellis fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + trellis = "Trellis", + /** + * Represents a light horizontal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lightHorizontal = "LightHorizontal", + /** + * Represents a light vertical fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lightVertical = "LightVertical", + /** + * Represents a light downward diagonal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lightDownwardDiagonal = "LightDownwardDiagonal", + /** + * Represents a light upward diagonal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lightUpwardDiagonal = "LightUpwardDiagonal", + /** + * Represents a small grid fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + smallGrid = "SmallGrid", + /** + * Represents a dotted diamond fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dottedDiamond = "DottedDiamond", + /** + * Represents a wide downward diagonal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + wideDownwardDiagonal = "WideDownwardDiagonal", + /** + * Represents a wide upward diagonal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + wideUpwardDiagonal = "WideUpwardDiagonal", + /** + * Represents a dashed upward diagonal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dashedUpwardDiagonal = "DashedUpwardDiagonal", + /** + * Represents a dashed downward diagonal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dashedDownwardDiagonal = "DashedDownwardDiagonal", + /** + * Represents a narrow vertical fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + narrowVertical = "NarrowVertical", + /** + * Represents a narrow horizontal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + narrowHorizontal = "NarrowHorizontal", + /** + * Represents a dashed vertical fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dashedVertical = "DashedVertical", + /** + * Represents a dashed horizontal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dashedHorizontal = "DashedHorizontal", + /** + * Represents a large confetti fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + largeConfetti = "LargeConfetti", + /** + * Represents a large grid fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + largeGrid = "LargeGrid", + /** + * Represents a horizontal brick fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + horizontalBrick = "HorizontalBrick", + /** + * Represents a large checkerboard fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + largeCheckerBoard = "LargeCheckerBoard", + /** + * Represents a small confetti fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + smallConfetti = "SmallConfetti", + /** + * Represents a zigzag fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + zigZag = "ZigZag", + /** + * Represents a solid diamond fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + solidDiamond = "SolidDiamond", + /** + * Represents a diagonal brick fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + diagonalBrick = "DiagonalBrick", + /** + * Represents an outlined diamond fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + outlinedDiamond = "OutlinedDiamond", + /** + * Represents a plaid fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + plaid = "Plaid", + /** + * Represents a sphere fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sphere = "Sphere", + /** + * Represents a weave fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + weave = "Weave", + /** + * Represents a dotted grid fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dottedGrid = "DottedGrid", + /** + * Represents a divot fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + divot = "Divot", + /** + * Represents a shingle fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shingle = "Shingle", + /** + * Represents a wave fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + wave = "Wave", + /** + * Represents a horizontal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + horizontal = "Horizontal", + /** + * Represents a vertical fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + vertical = "Vertical", + /** + * Represents a cross fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + cross = "Cross", + /** + * Represents a downward diagonal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + downwardDiagonal = "DownwardDiagonal", + /** + * Represents an upward diagonal fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + upwardDiagonal = "UpwardDiagonal", + /** + * Represents a diagonal cross fill pattern. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + diagonalCross = "DiagonalCross", + } + /** + * Indicates the effects camera type used by the specified object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PresetCamera { + /** + * Represents a mixed camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents a legacy oblique top-left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyObliqueTopLeft = "LegacyObliqueTopLeft", + /** + * Represents a legacy oblique top camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyObliqueTop = "LegacyObliqueTop", + /** + * Represents a legacy oblique top-right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyObliqueTopRight = "LegacyObliqueTopRight", + /** + * Represents a legacy oblique left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyObliqueLeft = "LegacyObliqueLeft", + /** + * Represents a legacy oblique front camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyObliqueFront = "LegacyObliqueFront", + /** + * Represents a legacy oblique right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyObliqueRight = "LegacyObliqueRight", + /** + * Represents a legacy oblique bottom-left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", + /** + * Represents a legacy oblique bottom camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyObliqueBottom = "LegacyObliqueBottom", + /** + * Represents a legacy oblique bottom-right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyObliqueBottomRight = "LegacyObliqueBottomRight", + /** + * Represents a legacy perspective top-left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", + /** + * Represents a legacy perspective top camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyPerspectiveTop = "LegacyPerspectiveTop", + /** + * Represents a legacy perspective top-right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", + /** + * Represents a legacy perspective left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyPerspectiveLeft = "LegacyPerspectiveLeft", + /** + * Represents a legacy perspective front camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyPerspectiveFront = "LegacyPerspectiveFront", + /** + * Represents a legacy perspective right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyPerspectiveRight = "LegacyPerspectiveRight", + /** + * Represents a legacy perspective bottom-left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", + /** + * Represents a legacy perspective bottom camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyPerspectiveBottom = "LegacyPerspectiveBottom", + /** + * Represents a legacy perspective bottom-right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", + /** + * Represents an orthographic front camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + orthographicFront = "OrthographicFront", + /** + * Represents an isometric top-up camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricTopUp = "IsometricTopUp", + /** + * Represents an isometric top-down camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricTopDown = "IsometricTopDown", + /** + * Represents an isometric bottom-up camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricBottomUp = "IsometricBottomUp", + /** + * Represents an isometric bottom-down camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricBottomDown = "IsometricBottomDown", + /** + * Represents an isometric left-up camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricLeftUp = "IsometricLeftUp", + /** + * Represents an isometric left-down camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricLeftDown = "IsometricLeftDown", + /** + * Represents an isometric right-up camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricRightUp = "IsometricRightUp", + /** + * Represents an isometric right-down camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricRightDown = "IsometricRightDown", + /** + * Represents an isometric off-axis 1 left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis1Left = "IsometricOffAxis1Left", + /** + * Represents an isometric off-axis 1 right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis1Right = "IsometricOffAxis1Right", + /** + * Represents an isometric off-axis 1 top camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis1Top = "IsometricOffAxis1Top", + /** + * Represents an isometric off-axis 2 left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis2Left = "IsometricOffAxis2Left", + /** + * Represents an isometric off-axis 2 right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis2Right = "IsometricOffAxis2Right", + /** + * Represents an isometric off-axis 2 top camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis2Top = "IsometricOffAxis2Top", + /** + * Represents an isometric off-axis 3 left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis3Left = "IsometricOffAxis3Left", + /** + * Represents an isometric off-axis 3 right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis3Right = "IsometricOffAxis3Right", + /** + * Represents an isometric off-axis 3 bottom camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", + /** + * Represents an isometric off-axis 4 left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis4Left = "IsometricOffAxis4Left", + /** + * Represents an isometric off-axis 4 right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis4Right = "IsometricOffAxis4Right", + /** + * Represents an isometric off-axis 4 bottom camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", + /** + * Represents an oblique top-left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + obliqueTopLeft = "ObliqueTopLeft", + /** + * Represents an oblique top camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + obliqueTop = "ObliqueTop", + /** + * Represents an oblique top-right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + obliqueTopRight = "ObliqueTopRight", + /** + * Represents an oblique left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + obliqueLeft = "ObliqueLeft", + /** + * Represents an oblique right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + obliqueRight = "ObliqueRight", + /** + * Represents an oblique bottom-left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + obliqueBottomLeft = "ObliqueBottomLeft", + /** + * Represents an oblique bottom camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + obliqueBottom = "ObliqueBottom", + /** + * Represents an oblique bottom-right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + obliqueBottomRight = "ObliqueBottomRight", + /** + * Represents a perspective front camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveFront = "PerspectiveFront", + /** + * Represents a perspective left camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveLeft = "PerspectiveLeft", + /** + * Represents a perspective right camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveRight = "PerspectiveRight", + /** + * Represents a perspective above camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveAbove = "PerspectiveAbove", + /** + * Represents a perspective below camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveBelow = "PerspectiveBelow", + /** + * Represents a perspective above-left facing camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", + /** + * Represents a perspective above-right facing camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", + /** + * Represents a perspective contrasting-left facing camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", + /** + * Represents a perspective contrasting-right facing camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", + /** + * Represents a perspective heroic-left facing camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", + /** + * Represents a perspective heroic-right facing camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", + /** + * Represents a perspective heroic-extreme left facing camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", + /** + * Represents a perspective heroic-extreme right facing camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", + /** + * Represents a relaxed perspective camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveRelaxed = "PerspectiveRelaxed", + /** + * Represents a moderately relaxed perspective camera type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + perspectiveRelaxedModerately = "PerspectiveRelaxedModerately", + } + /** + * Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PresetExtrusionDirection { + /** + * Represents a mixed extrusion direction. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents an extrusion direction to the bottom-right. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottomRight = "BottomRight", + /** + * Represents an extrusion direction to the bottom. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottom = "Bottom", + /** + * Represents an extrusion direction to the bottom-left. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottomLeft = "BottomLeft", + /** + * Represents an extrusion direction to the right. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + right = "Right", + /** + * Represents no extrusion direction. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + none = "None", + /** + * Represents an extrusion direction to the left. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + left = "Left", + /** + * Represents an extrusion direction to the top-right. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + topRight = "TopRight", + /** + * Represents an extrusion direction to the top. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + top = "Top", + /** + * Represents an extrusion direction to the top-left. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + topLeft = "TopLeft", + } + /** + * Specifies which predefined gradient to use to fill a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PresetGradientType { + /** + * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * A warm gradient resembling an early sunset. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + earlySunset = "EarlySunset", + /** + * A deeper, richer gradient resembling a late sunset. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lateSunset = "LateSunset", + /** + * A dark gradient evoking the colors of nightfall. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nightfall = "Nightfall", + /** + * A light gradient representing the colors of daybreak. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + daybreak = "Daybreak", + /** + * A gradient that mimics the colors of the horizon. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + horizon = "Horizon", + /** + * A warm, sandy gradient inspired by desert tones. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + desert = "Desert", + /** + * A cool gradient reflecting ocean hues. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + ocean = "Ocean", + /** + * A soft, tranquil gradient resembling calm water. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + calmWater = "CalmWater", + /** + * A vivid gradient with fiery tones. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fire = "Fire", + /** + * A muted gradient with fog-like softness. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fog = "Fog", + /** + * A natural green gradient inspired by moss. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + moss = "Moss", + /** + * A vibrant gradient with peacock feather colors. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + peacock = "Peacock", + /** + * A light, golden gradient resembling wheat. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + wheat = "Wheat", + /** + * A warm, aged paper-like gradient. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + parchment = "Parchment", + /** + * A rich, reddish-brown gradient like mahogany wood. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mahogany = "Mahogany", + /** + * A colorful gradient resembling a rainbow. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rainbow = "Rainbow", + /** + * A variation of the rainbow gradient with different color emphasis. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rainbowII = "RainbowII", + /** + * A shiny, metallic gold gradient. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gold = "Gold", + /** + * A variation of the gold gradient with different tones. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + goldII = "GoldII", + /** + * A metallic gradient resembling brass. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + brass = "Brass", + /** + * A sleek, reflective chrome gradient. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + chrome = "Chrome", + /** + * A variation of the chrome gradient with alternate highlights. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + chromeII = "ChromeII", + /** + * A smooth, metallic silver gradient. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + silver = "Silver", + /** + * A deep blue gradient inspired by sapphire. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sapphire = "Sapphire", + } + /** + * Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PresetLightingDirection { + /** + * Represents a mixed lighting direction. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents lighting from the top-left. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + topLeft = "TopLeft", + /** + * Represents lighting from the top. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + top = "Top", + /** + * Represents lighting from the top-right. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + topRight = "TopRight", + /** + * Represents lighting from the left. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + left = "Left", + /** + * Represents no lighting. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + none = "None", + /** + * Represents lighting from the right. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + right = "Right", + /** + * Represents lighting from the bottom-left. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottomLeft = "BottomLeft", + /** + * Represents lighting from the bottom. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottom = "Bottom", + /** + * Represents lighting from the bottom-right. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottomRight = "BottomRight", + } + /** + * Specifies the intensity of light used on a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PresetLightingSoftness { + /** + * Represents a mixed lighting softness. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents dim lighting. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dim = "Dim", + /** + * Represents normal lighting. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + normal = "Normal", + /** + * Represents bright lighting. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bright = "Bright", + } + /** + * Specifies the extrusion surface material. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PresetMaterial { + /** + * Represents a mixed material type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents a matte material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + matte = "Matte", + /** + * Represents a plastic material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + plastic = "Plastic", + /** + * Represents a metal material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + metal = "Metal", + /** + * Represents a wireframe material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + wireFrame = "WireFrame", + /** + * Represents a second matte material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + matte2 = "Matte2", + /** + * Represents a second plastic material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + plastic2 = "Plastic2", + /** + * Represents a second metal material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + metal2 = "Metal2", + /** + * Represents a warm matte material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + warmMatte = "WarmMatte", + /** + * Represents a translucent powder material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + translucentPowder = "TranslucentPowder", + /** + * Represents a powder material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + powder = "Powder", + /** + * Represents a dark edge material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + darkEdge = "DarkEdge", + /** + * Represents a soft edge material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + softEdge = "SoftEdge", + /** + * Represents a clear material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + clear = "Clear", + /** + * Represents a flat material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + flat = "Flat", + /** + * Represents a soft metal material. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + softMetal = "SoftMetal", + } + /** + * Specifies texture to be used to fill a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PresetTexture { + /** + * Represents a mixed texture type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents a papyrus texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + papyrus = "Papyrus", + /** + * Represents a canvas texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + canvas = "Canvas", + /** + * Represents a denim texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + denim = "Denim", + /** + * Represents a woven mat texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + wovenMat = "WovenMat", + /** + * Represents a water droplets texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + waterDroplets = "WaterDroplets", + /** + * Represents a paper bag texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + paperBag = "PaperBag", + /** + * Represents a fish fossil texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fishFossil = "FishFossil", + /** + * Represents a sand texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sand = "Sand", + /** + * Represents a green marble texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + greenMarble = "GreenMarble", + /** + * Represents a white marble texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + whiteMarble = "WhiteMarble", + /** + * Represents a brown marble texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + brownMarble = "BrownMarble", + /** + * Represents a granite texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + granite = "Granite", + /** + * Represents a newsprint texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + newsprint = "Newsprint", + /** + * Represents a recycled paper texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + recycledPaper = "RecycledPaper", + /** + * Represents a parchment texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + parchment = "Parchment", + /** + * Represents a stationery texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + stationery = "Stationery", + /** + * Represents a blue tissue paper texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + blueTissuePaper = "BlueTissuePaper", + /** + * Represents a pink tissue paper texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pinkTissuePaper = "PinkTissuePaper", + /** + * Represents a purple mesh texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + purpleMesh = "PurpleMesh", + /** + * Represents a bouquet texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bouquet = "Bouquet", + /** + * Represents a cork texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + cork = "Cork", + /** + * Represents a walnut texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + walnut = "Walnut", + /** + * Represents an oak texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + oak = "Oak", + /** + * Represents a medium wood texture. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mediumWood = "MediumWood", + } + /** + * Specifies an extrusion (three-dimensional) format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PresetThreeDimensionalFormat { + /** + * Represents a mixed three-dimensional format. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents three-dimensional format 1. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format1 = "Format1", + /** + * Represents three-dimensional format 2. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format2 = "Format2", + /** + * Represents three-dimensional format 3. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format3 = "Format3", + /** + * Represents three-dimensional format 4. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format4 = "Format4", + /** + * Represents three-dimensional format 5. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format5 = "Format5", + /** + * Represents three-dimensional format 6. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format6 = "Format6", + /** + * Represents three-dimensional format 7. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format7 = "Format7", + /** + * Represents three-dimensional format 8. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format8 = "Format8", + /** + * Represents three-dimensional format 9. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format9 = "Format9", + /** + * Represents three-dimensional format 10. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format10 = "Format10", + /** + * Represents three-dimensional format 11. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format11 = "Format11", + /** + * Represents three-dimensional format 12. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format12 = "Format12", + /** + * Represents three-dimensional format 13. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format13 = "Format13", + /** + * Represents three-dimensional format 14. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format14 = "Format14", + /** + * Represents three-dimensional format 15. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format15 = "Format15", + /** + * Represents three-dimensional format 16. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format16 = "Format16", + /** + * Represents three-dimensional format 17. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format17 = "Format17", + /** + * Represents three-dimensional format 18. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format18 = "Format18", + /** + * Represents three-dimensional format 19. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format19 = "Format19", + /** + * Represents three-dimensional format 20. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + format20 = "Format20", + } + /** + * Specifies the type of the {@link Word.ReflectionFormat} object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ReflectionType { + /** + * Represents a mixed reflection type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents no reflection. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + none = "None", + /** + * Represents reflection type 1. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type1 = "Type1", + /** + * Represents reflection type 2. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type2 = "Type2", + /** + * Represents reflection type 3. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type3 = "Type3", + /** + * Represents reflection type 4. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type4 = "Type4", + /** + * Represents reflection type 5. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type5 = "Type5", + /** + * Represents reflection type 6. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type6 = "Type6", + /** + * Represents reflection type 7. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type7 = "Type7", + /** + * Represents reflection type 8. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type8 = "Type8", + /** + * Represents reflection type 9. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type9 = "Type9", + } + /** + * Specifies the type of shadowing effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ShadowStyle { + /** + * Represents a mixed shadow style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents an outer shadow style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + outerShadow = "OuterShadow", + /** + * Represents an inner shadow style. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + innerShadow = "InnerShadow", + } + /** + * Specifies the type of shadow displayed with a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ShadowType { + /** + * Represents a mixed shadow type. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Represents shadow type 1. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type1 = "Type1", + /** + * Represents shadow type 2. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type2 = "Type2", + /** + * Represents shadow type 3. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type3 = "Type3", + /** + * Represents shadow type 4. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type4 = "Type4", + /** + * Represents shadow type 5. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type5 = "Type5", + /** + * Represents shadow type 6. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type6 = "Type6", + /** + * Represents shadow type 7. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type7 = "Type7", + /** + * Represents shadow type 8. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type8 = "Type8", + /** + * Represents shadow type 9. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type9 = "Type9", + /** + * Represents shadow type 10. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type10 = "Type10", + /** + * Represents shadow type 11. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type11 = "Type11", + /** + * Represents shadow type 12. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type12 = "Type12", + /** + * Represents shadow type 13. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type13 = "Type13", + /** + * Represents shadow type 14. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type14 = "Type14", + /** + * Represents shadow type 15. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type15 = "Type15", + /** + * Represents shadow type 16. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type16 = "Type16", + /** + * Represents shadow type 17. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type17 = "Type17", + /** + * Represents shadow type 18. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type18 = "Type18", + /** + * Represents shadow type 19. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type19 = "Type19", + /** + * Represents shadow type 20. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type20 = "Type20", + /** + * Represents shadow type 21. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type21 = "Type21", + /** + * Represents shadow type 22. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type22 = "Type22", + /** + * Represents shadow type 23. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type23 = "Type23", + /** + * Represents shadow type 24. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type24 = "Type24", + /** + * Represents shadow type 25. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type25 = "Type25", + /** + * Represents shadow type 26. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type26 = "Type26", + /** + * Represents shadow type 27. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type27 = "Type27", + /** + * Represents shadow type 28. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type28 = "Type28", + /** + * Represents shadow type 29. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type29 = "Type29", + /** + * Represents shadow type 30. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type30 = "Type30", + /** + * Represents shadow type 31. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type31 = "Type31", + /** + * Represents shadow type 32. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type32 = "Type32", + /** + * Represents shadow type 33. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type33 = "Type33", + /** + * Represents shadow type 34. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type34 = "Type34", + /** + * Represents shadow type 35. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type35 = "Type35", + /** + * Represents shadow type 36. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type36 = "Type36", + /** + * Represents shadow type 37. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type37 = "Type37", + /** + * Represents shadow type 38. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type38 = "Type38", + /** + * Represents shadow type 39. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type39 = "Type39", + /** + * Represents shadow type 40. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type40 = "Type40", + /** + * Represents shadow type 41. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type41 = "Type41", + /** + * Represents shadow type 42. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type42 = "Type42", + /** + * Represents shadow type 43. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type43 = "Type43", + } + /** + * Specifies the stylistic set to apply to the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum StylisticSet { + /** + * Default stylistic set. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + default = "Default", + /** + * Stylistic set 01. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set01 = "Set01", + /** + * Stylistic set 02. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set02 = "Set02", + /** + * Stylistic set 03. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set03 = "Set03", + /** + * Stylistic set 04. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set04 = "Set04", + /** + * Stylistic set 05. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set05 = "Set05", + /** + * Stylistic set 06. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set06 = "Set06", + /** + * Stylistic set 07. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set07 = "Set07", + /** + * Stylistic set 08. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set08 = "Set08", + /** + * Stylistic set 09. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set09 = "Set09", + /** + * Stylistic set 10. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set10 = "Set10", + /** + * Stylistic set 11. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set11 = "Set11", + /** + * Stylistic set 12. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set12 = "Set12", + /** + * Stylistic set 13. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set13 = "Set13", + /** + * Stylistic set 14. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set14 = "Set14", + /** + * Stylistic set 15. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set15 = "Set15", + /** + * Stylistic set 16. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set16 = "Set16", + /** + * Stylistic set 17. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set17 = "Set17", + /** + * Stylistic set 18. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set18 = "Set18", + /** + * Stylistic set 19. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set19 = "Set19", + /** + * Stylistic set 20. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + set20 = "Set20", + } + /** + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum TextureAlignment { + /** + * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * Aligns the texture to the top-left corner of the shape. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + topLeft = "TopLeft", + /** + * Aligns the texture to the top center of the shape. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + top = "Top", + /** + * Aligns the texture to the top-right corner of the shape. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + topRight = "TopRight", + /** + * Aligns the texture to the middle left side of the shape. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + left = "Left", + /** + * Aligns the texture to the center of the shape. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + center = "Center", + /** + * Aligns the texture to the middle right side of the shape. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + right = "Right", + /** + * Aligns the texture to the bottom-left corner of the shape. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottomLeft = "BottomLeft", + /** + * Aligns the texture to the bottom center of the shape. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottom = "Bottom", + /** + * Aligns the texture to the bottom-right corner of the shape. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottomRight = "BottomRight", + } + /** + * Specifies the texture type for the selected fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum TextureType { + /** + * Mixed texture type. Used when multiple shapes with different texture types are selected. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mixed = "Mixed", + /** + * A predefined texture selected from the built-in texture gallery. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + preset = "Preset", + /** + * A custom texture defined by the user, typically from an image file. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + userDefined = "UserDefined", + } + /** + * Specifies the theme colors for document themes. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum ThemeColorIndex { + /** + * Not a theme color. Used when the color is not part of the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + notThemeColor = "NotThemeColor", + /** + * The first dark color in the main theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mainDark1 = "MainDark1", + /** + * The first light color in the main theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mainLight1 = "MainLight1", + /** + * The second dark color in the main theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mainDark2 = "MainDark2", + /** + * The second light color in the main theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mainLight2 = "MainLight2", + /** + * The first accent color in the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + accent1 = "Accent1", + /** + * The second accent color in the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + accent2 = "Accent2", + /** + * The third accent color in the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + accent3 = "Accent3", + /** + * The fourth accent color in the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + accent4 = "Accent4", + /** + * The fifth accent color in the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + accent5 = "Accent5", + /** + * The sixth accent color in the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + accent6 = "Accent6", + /** + * The color used for hyperlinks. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hyperlink = "Hyperlink", + /** + * The color used for followed hyperlinks. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hyperlinkFollowed = "HyperlinkFollowed", + /** + * The first background color in the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + background1 = "Background1", + /** + * The first text color in the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + text1 = "Text1", + /** + * The second background color in the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + background2 = "Background2", + /** + * The second text color in the theme. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + text2 = "Text2", + } + /** + * Specifies the hyperlink type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum HyperlinkType { + /** + * Represents a hyperlink to a range in the document. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range = "Range", + /** + * Represents a hyperlink to a shape in the document. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shape = "Shape", + /** + * Represents a hyperlink to an inline shape in the document. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + inlineShape = "InlineShape", + } + /** + * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class Bibliography extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly sources: Word.SourceCollection; + /** + * Specifies the name of the active style to use for the bibliography. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bibliographyStyle: string; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.BibliographyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Bibliography): void; + /** + * Generates a unique identification tag for a bibliography source and returns a string that represents the tag. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + generateUniqueTag(): OfficeExtension.ClientResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.Bibliography; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Bibliography; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Bibliography; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Bibliography; + /** + * 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.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.BibliographyData; + } + /** + * Represents a collection of {@link Word.Source} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class SourceCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Source[]; + /** + * Adds a new `Source` object to the collection. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param xml A string containing the XML data for the source. + * @returns A `Source` object that was added to the collection. + */ + add(xml: string): Word.Source; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SourceCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SourceCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.SourceCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.SourceCollection; + /** + * 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.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.SourceCollectionData; + } + /** + * Represents an individual source, such as a book, journal article, or interview. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class Source extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Gets if the `Source` object has been cited in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly isCited: boolean; + /** + * Gets the tag of the source. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly tag: string; + /** + * Gets the XML representation of the source. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly xml: string; + /** + * Deletes the `Source` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + delete(): void; + /** + * Returns the value of a field in the bibliography `Source` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param name The name of the field to retrieve. + */ + getFieldByName(name: string): OfficeExtension.ClientResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SourceLoadOptions): Word.Source; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.Source; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Source; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Source; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Source; + /** + * 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.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SourceData; + } + /** + * Represents the page setup settings for a Word document or section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class PageSetup extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lineNumbering: Word.LineNumbering; + /** + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + readonly textColumns: Word.TextColumnCollection; + /** + * Specifies whether Microsoft Word prints the document as a booklet. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bookFoldPrinting: boolean; + /** + * Specifies the number of pages for each booklet. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bookFoldPrintingSheets: number; + /** + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bookFoldReversePrinting: boolean; + /** + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottomMargin: number; + /** + * Specifies the number of characters per line in the document grid. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + charsLine: number; + /** + * Specifies whether the first page has a different header and footer. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + differentFirstPageHeaderFooter: boolean; + /** + * Specifies the distance between the footer and the bottom of the page in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + footerDistance: number; + /** + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gutter: number; + /** + * Specifies on which side the gutter appears in a document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; + /** + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; + /** + * Specifies the distance between the header and the top of the page in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + headerDistance: number; + /** + * Specifies the layout mode for the current document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + /** + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + leftMargin: number; + /** + * Specifies the number of lines per page in the document grid. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + linesPage: number; + /** + * Specifies if the inside and outside margins of facing pages are the same width. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mirrorMargins: boolean; + /** + * Specifies whether odd and even pages have different headers and footers. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + oddAndEvenPagesHeaderFooter: boolean; + /** + * Specifies the orientation of the page. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + orientation: Word.PageOrientation | "Portrait" | "Landscape"; + /** + * Specifies the page height in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageHeight: number; + /** + * Specifies the page width in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageWidth: number; + /** + * Specifies the paper size of the page. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + /** + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rightMargin: number; + /** + * Specifies the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + /** + * Specifies the type of section break for the specified object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + /** + * Specifies whether to show the grid. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + showGrid: boolean; + /** + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + suppressEndnotes: boolean; + /** + * Specifies the top margin of the page in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + topMargin: number; + /** + * Specifies whether to print two pages per sheet. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + twoPagesOnOne: boolean; + /** + * Specifies the vertical alignment of text on each page in a document or section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.PageSetup): void; + /** + * Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + setAsTemplateDefault(): void; + /** + * Switches between portrait and landscape page orientations for a document or section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + togglePortrait(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.PageSetup; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.PageSetup; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.PageSetup; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.PageSetup; + /** + * 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.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.PageSetupData; + } + /** + * Represents line numbers in the left margin or to the left of each newspaper-style column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class LineNumbering extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the numeric increment for line numbers. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + countBy: number; + /** + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + distanceFromText: number; + /** + * Specifies if line numbering is active for the specified document, section, or sections. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isActive: boolean; + /** + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + /** + * Specifies the starting line number. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + startingNumber: number; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.LineNumberingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LineNumbering): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.LineNumberingLoadOptions): Word.LineNumbering; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.LineNumbering; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.LineNumbering; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.LineNumbering; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.LineNumbering; + /** + * 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.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.LineNumberingData; + } + /** + * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class TextColumnCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.TextColumn[]; + /** + * Returns a `TextColumn` object that represents a new text column added to a section or document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param options Optional. Options for configuring the new text column. + * @returns A `TextColumn` object that represents a new text column added to the document. + */ + add(options?: Word.TextColumnAddOptions): Word.TextColumn; + /** + * Gets the direction in which text flows from one text column to the next. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + getFlowDirection(): OfficeExtension.ClientResult; + /** + * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + getHasLineBetween(): OfficeExtension.ClientResult; + /** + * Gets whether text columns are evenly spaced. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + getIsEvenlySpaced(): OfficeExtension.ClientResult; + /** + * Arranges text into the specified number of text columns. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param numColumns The number of columns the text is to be arranged into. + */ + setCount(numColumns: number): void; + /** + * Sets the direction in which text flows from one text column to the next. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param value The flow direction to set. + */ + setFlowDirection(value: Word.FlowDirection): void; + /** + * Sets the direction in which text flows from one text column to the next. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param value The flow direction to set. + */ + setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; + /** + * Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param value `true` to show vertical lines between columns. + */ + setHasLineBetween(value: boolean): void; + /** + * Sets whether text columns are evenly spaced. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + * + * @param value `true` to evenly space all the text columns in the document. + */ + setIsEvenlySpaced(value: boolean): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.TextColumnCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TextColumnCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TextColumnCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TextColumnCollection; + /** + * 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.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TextColumnCollectionData; + } + /** + * Represents options for a new text column in a document or section of a document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface TextColumnAddOptions { + /** + * If provided, specifies whether to evenly space all the text columns in the document. The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isEvenlySpaced?: boolean; + /** + * If provided, specifies the spacing between the text columns in the document, in points. + The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spacing?: number; + /** + * If provided, specifies the width of the new text column in the document, in points. + The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + width?: number; + } + /** + * Represents a single text column in a section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + class TextColumn extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spaceAfter: number; + /** + * Specifies the width, in points, of the specified text columns. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + width: number; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TextColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TextColumn): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.TextColumnLoadOptions): Word.TextColumn; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.TextColumn; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TextColumn; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TextColumn; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.TextColumn; + /** + * 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.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TextColumnData; + } + /** + * Specifies the case of the text in the specified range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum CharacterCase { + /** + * Specifies the next case. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + next = "Next", + /** + * Specifies lowercase. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lower = "Lower", + /** + * Specifies uppercase. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + upper = "Upper", + /** + * Specifies title case for each word. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + titleWord = "TitleWord", + /** + * Specifies title case for the sentence. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + titleSentence = "TitleSentence", + /** + * Specifies toggle case. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + toggle = "Toggle", + /** + * Specifies half-width characters. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + halfWidth = "HalfWidth", + /** + * Specifies full-width characters. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fullWidth = "FullWidth", + /** + * Specifies Katakana characters. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + katakana = "Katakana", + /** + * Specifies Hiragana characters. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hiragana = "Hiragana", + } + /** + * Specifies the character width of the text in the specified range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum CharacterWidth { + /** + * Specifies half-width characters. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + half = "Half", + /** + * Specifies full-width characters. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + full = "Full", + } + /** + * Specifies the seek view options in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum SeekView { + /** + * Main document. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + mainDocument = "MainDocument", + /** + * Primary header. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + primaryHeader = "PrimaryHeader", + /** + * First page header. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + firstPageHeader = "FirstPageHeader", + /** + * Even pages header. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + evenPagesHeader = "EvenPagesHeader", + /** + * Primary footer. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + primaryFooter = "PrimaryFooter", + /** + * First page footer. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + firstPageFooter = "FirstPageFooter", + /** + * Even pages footer. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + evenPagesFooter = "EvenPagesFooter", + /** + * Footnotes. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnotes = "Footnotes", + /** + * Endnotes. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnotes = "Endnotes", + /** + * Current page header. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + currentPageHeader = "CurrentPageHeader", + /** + * Current page footer. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + currentPageFooter = "CurrentPageFooter", + } + /** + * Specifies the source documents to show. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ShowSourceDocuments { + /** + * Specifies that no source documents are shown. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * Specifies that the original source document is shown. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + original = "Original", + /** + * Specifies that the revised source document is shown. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + revised = "Revised", + /** + * Specifies that both the original and revised source documents are shown. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + both = "Both", + } + /** + * Specifies the special pane options in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum SpecialPane { + /** + * None. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * Primary header. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + primaryHeader = "PrimaryHeader", + /** + * First page header. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + firstPageHeader = "FirstPageHeader", + /** + * Even pages header. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + evenPagesHeader = "EvenPagesHeader", + /** + * Primary footer. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + primaryFooter = "PrimaryFooter", + /** + * First page footer. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + firstPageFooter = "FirstPageFooter", + /** + * Even pages footer. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + evenPagesFooter = "EvenPagesFooter", + /** + * Footnotes. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnotes = "Footnotes", + /** + * Endnotes. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnotes = "Endnotes", + /** + * Footnote continuation notice. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnoteContinuationNotice = "FootnoteContinuationNotice", + /** + * Footnote continuation separator. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnoteContinuationSeparator = "FootnoteContinuationSeparator", + /** + * Footnote separator. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnoteSeparator = "FootnoteSeparator", + /** + * Endnote continuation notice. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnoteContinuationNotice = "EndnoteContinuationNotice", + /** + * Endnote continuation separator. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnoteContinuationSeparator = "EndnoteContinuationSeparator", + /** + * Endnote separator. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnoteSeparator = "EndnoteSeparator", + /** + * Comments. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + comments = "Comments", + /** + * Current page header. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + currentPageHeader = "CurrentPageHeader", + /** + * Current page footer. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + currentPageFooter = "CurrentPageFooter", + /** + * Revisions. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + revisions = "Revisions", + /** + * Revisions horizontal. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + revisionsHoriz = "RevisionsHoriz", + /** + * Revisions vertical. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + revisionsVert = "RevisionsVert", + } + /** + * Specifies the save options. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum SaveConfiguration { + /** + * Specifies not to save changes. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + doNotSaveChanges = "DoNotSaveChanges", + /** + * Specifies to save changes. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + saveChanges = "SaveChanges", + /** + * Specifies to prompt to save changes. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + promptToSaveChanges = "PromptToSaveChanges", + } + /** + * Specifies the page color options in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum PageColor { + /** + * None. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * Sepia. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sepia = "Sepia", + /** + * Inverse. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + inverse = "Inverse", + } + /** + * Specifies the page movement type in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum PageMovementType { + /** + * Vertical. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + vertical = "Vertical", + /** + * Side to side. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sideToSide = "SideToSide", + } + /** + * Specifies the margin options in reading layout view in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ReadingLayoutMargin { + /** + * Microsoft Word determines automatically whether to show or hide the margins based on the available space. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + automatic = "Automatic", + /** + * Hides margins. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + suppress = "Suppress", + /** + * Shows margins. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + full = "Full", + } + /** + * Specifies the margin for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum RevisionsBalloonMargin { + /** + * Left margin. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + left = "Left", + /** + * Right margin. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + right = "Right", + } + /** + * Specifies the width type for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum RevisionsBalloonWidthType { + /** + * Balloon width as a percentage. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + percent = "Percent", + /** + * Balloon width in points. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + points = "Points", + } + /** + * Specifies the extent of markup visible in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum RevisionsMarkup { + /** + * No markup. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * Simple markup. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + simple = "Simple", + /** + * All markup. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + all = "All", + } + /** + * Specifies the display mode for tracked changes in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum RevisionsMode { + /** + * Balloon. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + balloon = "Balloon", + /** + * Inline. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + inline = "Inline", + /** + * Mixed. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + mixed = "Mixed", + } + /** + * Specifies whether Word displays the original version of a document or a version with revisions and formatting changes applied. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum RevisionsView { + /** + * Final view. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + final = "Final", + /** + * Original view. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + original = "Original", + } + /** + * Specifies the revision type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum RevisionType { + /** + * No revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * Insert revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + insert = "Insert", + /** + * Delete revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + delete = "Delete", + /** + * Property revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + property = "Property", + /** + * Paragraph number revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + paragraphNumber = "ParagraphNumber", + /** + * Display field revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + displayField = "DisplayField", + /** + * Reconcile revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + reconcile = "Reconcile", + /** + * Conflict revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + conflict = "Conflict", + /** + * Style revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + style = "Style", + /** + * Replace revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + replace = "Replace", + /** + * Paragraph property revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + paragraphProperty = "ParagraphProperty", + /** + * Table property revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tableProperty = "TableProperty", + /** + * Section property revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sectionProperty = "SectionProperty", + /** + * Style definition revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + styleDefinition = "StyleDefinition", + /** + * Moved from revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + movedFrom = "MovedFrom", + /** + * Moved to revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + movedTo = "MovedTo", + /** + * Cell insertion revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + cellInsertion = "CellInsertion", + /** + * Cell deletion revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + cellDeletion = "CellDeletion", + /** + * Cell merge revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + cellMerge = "CellMerge", + /** + * Cell split revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + cellSplit = "CellSplit", + /** + * Conflict insert revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + conflictInsert = "ConflictInsert", + /** + * Conflict delete revision. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + conflictDelete = "ConflictDelete", + } + /** + * Specifies the column width options in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ColumnWidth { + /** + * Narrow column width. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + narrow = "Narrow", + /** + * Default column width. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + default = "Default", + /** + * Wide column width. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + wide = "Wide", + } + /** + * Specifies the field shading options in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum FieldShading { + /** + * Never shade fields. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + never = "Never", + /** + * Always shade fields. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + always = "Always", + /** + * Shade fields when selected. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + whenSelected = "WhenSelected", + } + /** + * Specifies the format for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum HorizontalInVerticalType { + /** + * No formatting is applied to the horizontal text. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * The horizontal text is sized to fit in the line of vertical text. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fitInLine = "FitInLine", + /** + * The line of vertical text is sized to accommodate the horizontal text. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + resizeLine = "ResizeLine", + } + /** + * Specifies the IME (Input Method Editor) mode. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ImeMode { + /** + * Specifies no control over the IME mode. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + noControl = "NoControl", + /** + * Specifies the IME mode is on. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + on = "On", + /** + * Specifies the IME mode is off. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + off = "Off", + /** + * Specifies the Hiragana IME mode. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + hiragana = "Hiragana", + /** + * Specifies the Katakana (double-byte) IME mode. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + katakana = "Katakana", + /** + * Specifies the Katakana (half-width) IME mode. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + katakanaHalf = "KatakanaHalf", + /** + * Specifies the full-width alphanumeric IME mode. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + alphaFull = "AlphaFull", + /** + * Specifies the half-width alphanumeric IME mode. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + alpha = "Alpha", + /** + * Specifies the full-width Hangul IME mode. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + hangulFull = "HangulFull", + /** + * Specifies the half-width Hangul IME mode. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + hangul = "Hangul", + } + /** + * Specifies the Kana type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum Kana { + /** + * Katakana Kana type. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + katakana = "Katakana", + /** + * Hiragana Kana type. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + hiragana = "Hiragana", + } + /** + * Specifies the two lines in one type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum TwoLinesInOneType { + /** + * No two lines in one. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * Two lines in one without brackets. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + noBrackets = "NoBrackets", + /** + * Two lines in one with parentheses. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + parentheses = "Parentheses", + /** + * Two lines in one with square brackets. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + squareBrackets = "SquareBrackets", + /** + * Two lines in one with angle brackets. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + angleBrackets = "AngleBrackets", + /** + * Two lines in one with curly brackets. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + curlyBrackets = "CurlyBrackets", + } + /** + * Specifies the view type in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ViewType { + /** + * Normal. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + normal = "Normal", + /** + * Outline. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + outline = "Outline", + /** + * Print. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + print = "Print", + /** + * Print preview. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + printPreview = "PrintPreview", + /** + * Master. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + master = "Master", + /** + * Web. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + web = "Web", + /** + * Reading. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + reading = "Reading", + /** + * Conflict. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + conflict = "Conflict", + } + /** + * Represents the state of the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum WindowState { + /** + * Represents the normal state of the window. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + normal = "Normal", + /** + * Represents the maximized state of the window. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + maximize = "Maximize", + /** + * Represents the minimized state of the window. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + minimize = "Minimize", + } + /** + * Specifies the type of the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum WindowType { + /** + * Specifies a document window. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + document = "Document", + /** + * Specifies a template window. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + template = "Template", + } + /** + * Represents the options for the {@link Word.Selection | Selection.delete} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectionDeleteOptions { + /** + * If provided, specifies the number of units to be deleted. To delete units after the selection, collapse the selection and use a positive number. To delete units before the selection, collapse the selection and use a negative number. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + count?: number; + /** + * If provided, specifies the unit by which the collapsed selection is to be deleted. The default value is `character`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.insertDateTime} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectionInsertDateTimeOptions { + /** + * If provided, specifies the calendar type to use when displaying the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + calendarType?: Word.CalendarTypeBidirectional | "Gregorian" | "Bidirectional"; + /** + * If provided, specifies the language in which to display the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + dateLanguage?: Word.DateLanguage | "Bidirectional" | "Latin"; + /** + * If provided, specifies the format to be used for displaying the date or time, or both. If this property is omitted, Microsoft Word uses the short-date style from the Windows Control Panel (Regional Settings icon). See {@link https://support.microsoft.com/office/47fbbdc1-52fa-416a-b8d5-ba24d881b698 | Date/Time data type} for format symbols. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + dateTimeFormat?: string; + /** + * If provided, specifies whether to insert the specified information as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + insertAsField?: boolean; + /** + * If provided, specifies whether to insert the specified information as full-width (double-byte) digits. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + insertAsFullWidth?: boolean; + } + /** + * Represents the options for the {@link Word.Selection | Selection.insertFormula} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectionInsertFormulaOptions { + /** + * If provided, specifies the mathematical formula you want the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} to evaluate. + The `formula` property is optional only if the selection is in a cell and there is at least one cell that contains a value above or to the left of the cell that contains the insertion point. If the cells above the insertion point contain values, the inserted field is `{=SUM(ABOVE)}`; if the cells to the left of the insertion point contain values, the inserted field is `{=SUM(LEFT)}`. If both the cells above the insertion point and the cells to the left of it contain values, Microsoft Word uses the following rules to determine which `SUM` function to insert. + + - If the cell immediately above the insertion point contains a value, Word inserts `{=SUM(ABOVE)}`. + + - If the cell immediately above the insertion point doesn't contain a value but the cell immediately to the left of the insertion point does, Word inserts `{=SUM(LEFT)}`. + + - If neither cell immediately above the insertion point nor the cell immediately below it contains a value, Word inserts `{=SUM(ABOVE)}`. + + - If you don't specify the `formula` property and all the cells above and to the left of the insertion point are empty, using the `= (Formula)` field causes an error. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formula?: string; + /** + * If provided, specifies the format for the result of the `= (Formula)` field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + numberFormat?: string; + } + /** + * Represents the options for the {@link Word.Selection | Selection.insertSymbol} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectionInsertSymbolOptions { + /** + * If provided, specifies the font bias for symbols. This argument is useful for setting the correct font bias for East Asian characters. The default value is `default`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bias?: Word.FontBias | "Standard" | "FarEast" | "NoSpecified"; + /** + * If provided, specifies the name of the font that contains the symbol. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + font?: string; + /** + * If provided, specifies whether the character is Unicode. `true` to insert the Unicode character specified by the `characterNumber` property when the `Selection.insertSymbol` method is called; `false` to instead insert the ANSI character specified by the `characterNumber` property. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + unicode?: boolean; + } + /** + * Represents the options for the {@link Word.Selection | Selection.moveLeft and Selection.moveRight} methods. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectionMoveLeftRightOptions { + /** + * If provided, specifies the number of units the selection is to be moved. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + count?: number; + /** + * If provided, specifies the type of movement. The movement direction (left or right) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + extend?: Word.MovementType | "Move" | "Extend"; + /** + * If provided, specifies the unit by which the selection is to be moved. The default value is `character`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.move} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectionMoveOptions { + /** + * If provided, specifies the number of units by which the range or selection is to be moved. If `count` is a positive number, the object is collapsed to its end position and moved backward in the document by the specified number of units. If `count` is a negative number, the object is collapsed to its start position and moved forward by the specified number of units. The default value is 1. You can also control the collapse direction by using the {@link Word.Selection | Selection.collapse} method before using the `move` method. If the range or selection is in the middle of a unit or isn't collapsed, moving it to the beginning or end of the unit counts as moving it one full unit. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + count?: number; + /** + * If provided, specifies the unit by which to move the ending character position. The default value is `character`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.moveEnd and Selection.moveStart} methods. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectionMoveStartEndOptions { + /** + * If provided, specifies the number of units to move. The affected character position (start or end) is according to the calling method. If this number is positive, the position is moved forward in the document. If this number is negative, the position is moved backward. If the affected position encounters the other position, the selection is collapsed and both the start and end positions move together. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + count?: number; + /** + * If provided, specifies the unit by which the selection's start or end position (per the calling method) is to be moved. The default value is `character`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.moveUp and Selection.moveDown} methods. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectionMoveUpDownOptions { + /** + * If provided, specifies the number of units the selection is to be moved. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + count?: number; + /** + * If provided, specifies the type of movement. The movement direction (up or down) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + extend?: Word.MovementType | "Move" | "Extend"; + /** + * If provided, specifies the unit by which to move the selection. The default value is `line`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.next} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectionNextOptions { + /** + * If provided, specifies the number of units by which you want to move ahead. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + count?: number; + /** + * If provided, specifies the type of units by which to move the selection. The default value is `character`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.previous} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface SelectionPreviousOptions { + /** + * If provided, specifies the number of units by which you want to move. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + count?: number; + /** + * If provided, specifies the type of unit by which to move the selection. The default value is `character`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents a selected range or the insertion point in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. + */ + class Selection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the objects in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly borders: Word.BorderUniversalCollection; + /** + * Returns a `RangeScopedCollection` object that represents each character in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly characters: Word.RangeScopedCollection; + /** + * Returns a `CommentCollection` object that represents all the comments in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly comments: Word.CommentCollection; + /** + * Returns a `FieldCollection` object that represents all the fields in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly fields: Word.FieldCollection; + /** + * Returns the `Font` object that represents the character formatting of the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly font: Word.Font; + /** + * Specifies a `Range` object that includes the formatted text in the range or selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formattedText: Word.Range; + /** + * Returns a `ParagraphCollection` object that represents all the paragraphs in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly paragraphs: Word.ParagraphCollection; + /** + * Returns the `Range` object for the portion of the document contained in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly range: Word.Range; + /** + * Returns the `SectionCollection` object in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly sections: Word.SectionCollection; + /** + * Returns the `RangeScopedCollection` object for each sentence in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly sentences: Word.RangeScopedCollection; + /** + * Returns the `ShadingUniversal` object for the shading formatting for the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly shading: Word.ShadingUniversal; + /** + * Returns the `TableCollection` object in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly tables: Word.TableCollection; + /** + * Returns the tables at the outermost nesting level in the current selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly topLevelTables: Word.TableCollection; + /** + * Returns the `RangeScopedCollection` object that represents each word in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly words: Word.RangeScopedCollection; + /** + * Specifies the ending character position of the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + end: number; + /** + * Specifies the width in which Word fits the text in the current selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fitTextWidth: number; + /** + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly hasNoProofing: boolean; + /** + * Returns whether the selection in the specified window or pane is active. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly isActive: boolean; + /** + * Specifies whether column selection mode is active. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isColumnSelectModeActive: boolean; + /** + * Returns whether the selection is at the end-of-row mark in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly isEndOfRowMark: boolean; + /** + * Specifies whether Extend mode is active. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isExtendModeActive: boolean; + /** + * Returns whether the insertion point is at the end of a line. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly isInsertionPointAtEndOfLine: boolean; + /** + * Specifies whether the beginning of the selection is active. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isStartActive: boolean; + /** + * Specifies whether Word has detected the language of the selected text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + languageDetected: boolean; + /** + * Returns the language for the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Returns the East Asian language for the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Returns the language for the selection that isn't classified as an East Asian language. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies the orientation of text in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + /** + * Specifies the starting character position of the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + start: number; + /** + * Returns the number of characters in the story that contains the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly storyLength: number; + /** + * Returns the story type for the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + /** + * Specifies the text in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + text: string; + /** + * Returns the selection type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + /** + * Calculates the first mathematical expression within the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * @returns The result of the calculation. + */ + calculate(): OfficeExtension.ClientResult; + /** + * Cancels a mode such as extend or column select. This is equivalent to pressing the Esc key. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + cancelMode(): void; + /** + * Removes character formatting applied through character styles. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + clearCharacterStyleFormatting(): void; + /** + * Removes character and paragraph formatting from the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + clearFormatting(): void; + /** + * Removes manually applied character formatting from the selected text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + clearManualCharacterFormatting(): void; + /** + * Removes manually applied paragraph formatting from the selected text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + clearManualParagraphFormatting(): void; + /** + * Removes all paragraph formatting from the selected text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + clearParagraphFormatting(): void; + /** + * Removes paragraph formatting applied through paragraph styles. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + clearParagraphStyle(): void; + /** + * Collapses the selection to the starting or ending position. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param direction Optional. Direction to collapse. + */ + collapse(direction?: Word.CollapseDirection): void; + /** + * Collapses the selection to the starting or ending position. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param direction Optional. Direction to collapse. + */ + collapse(direction?: "Start" | "End"): void; + /** + * Copies the selection to the Clipboard as a picture. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + copyAsPictureToClipboard(): void; + /** + * Copies the character formatting of the first character in the selected text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + copyFormat(): void; + /** + * Copies the selection to the Clipboard. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + copyToClipboard(): void; + /** + * Adds a default-sized text box around the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + createTextBox(): void; + /** + * Removes the selected content from the document and moves it to the Clipboard. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + cut(): void; + /** + * Deletes the specified number of characters or words. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for deleting text. + * @returns The number of characters deleted. + */ + delete(options?: Word.SelectionDeleteOptions): OfficeExtension.ClientResult; + /** + * Analyzes the selected text to determine the language that it's written in. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + detectLanguage(): void; + /** + * Expands the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param unit Optional. The unit to expand. + * @returns The number of characters added to the range or selection. + */ + expand(unit?: Word.OperationUnit): OfficeExtension.ClientResult; + /** + * Expands the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param unit Optional. The unit to expand. + * @returns The number of characters added to the range or selection. + */ + expand(unit?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): OfficeExtension.ClientResult; + /** + * Expands the selection to include the entire story. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + expandToWholeStory(): void; + /** + * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param character Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. + */ + extend(character?: Word.OperationUnit): void; + /** + * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param character Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. + */ + extend(character?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): void; + /** + * Returns a `Range` object that represents the next unit relative to the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for the `next` operation. + * @returns A `Range` object that represents the next unit relative to the selection. + */ + getNextRange(options?: Word.SelectionNextOptions): Word.Range; + /** + * Returns a `Range` object that represents the previous unit relative to the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for the `previous` operation. + * @returns A `Range` object that represents the previous unit relative to the selection. + */ + getPreviousRange(options?: Word.SelectionPreviousOptions): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. + */ + goToNext(what: Word.GoToItem): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. + */ + goToNext(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. + */ + goToPrevious(what: Word.GoToItem): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. + */ + goToPrevious(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + /** + * Inserts the specified text at the end of the range or selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param text Text to insert. + */ + insertAfter(text: string): void; + /** + * Inserts the specified text before the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param text Text to insert. + */ + insertBefore(text: string): void; + /** + * Adds cells to an existing table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param shiftCells Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. + */ + insertCells(shiftCells?: Word.TableCellInsertionLocation): void; + /** + * Adds cells to an existing table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param shiftCells Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. + */ + insertCells(shiftCells?: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"): void; + /** + * Inserts columns to the left of the column that contains the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + insertColumnsLeft(): void; + /** + * Inserts columns to the right of the current selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + insertColumnsRight(): void; + /** + * Inserts the current date or time, or both, either as text or as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for inserting the date or time. + */ + insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void; + /** + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Formula field} at the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for inserting the formula. + */ + insertFormula(options?: Word.SelectionInsertFormulaOptions): void; + /** + * Inserts a new page at the position of the insertion point. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + insertNewPage(): void; + /** + * Inserts a paragraph mark after the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + insertParagraphAfter(): void; + /** + * Inserts a new paragraph before the selection or range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + insertParagraphBefore(): void; + /** + * Inserts a special hidden paragraph mark that allows Word to join paragraphs formatted using different paragraph styles. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + insertParagraphStyleSeparator(): void; + /** + * Inserts rows above the current selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param numRows Optional. Number of rows to insert. + */ + insertRowsAbove(numRows: number): void; + /** + * Inserts rows below the current selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param numRows Optional. Number of rows to insert. + */ + insertRowsBelow(numRows: number): void; + /** + * Inserts a symbol in place of the specified selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param characterNumber The character number of the symbol. + * @param options Optional. Options for inserting the symbol. + */ + insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions): void; + /** + * Inserts the specified text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param Text The text to insert. + */ + insertText(Text: string): void; + /** + * Inserts the specified XML into the document at the cursor, replacing any selected text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param xml The XML string to insert. + * @param transform Optional. XSL transform to apply. + */ + insertXml(xml: string, transform?: string): void; + /** + * Returns whether the selection is equal to the specified range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param range The range to compare. + * @returns `true` if the selection is equal to the specified range. + */ + isEqual(range: Word.Range): OfficeExtension.ClientResult; + /** + * Returns `true` if the selection is contained within the specified range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param range The range to compare. + * @returns `true` if the selection is contained within the specified range. + */ + isInRange(range: Word.Range): OfficeExtension.ClientResult; + /** + * Returns whether the selection is in the same story as the specified range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param range The range to compare. + * @returns `true` if the selection is in the same story as the specified range. + */ + isInStory(range: Word.Range): OfficeExtension.ClientResult; + /** + * Collapses the selection to its start or end position and then moves the collapsed object by the specified number of units. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for moving the selection. + * @returns The number of characters by which the selection was moved. + */ + move(options?: Word.SelectionMoveOptions): OfficeExtension.ClientResult; + /** + * Moves the selection down. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for moving down. + * @returns The number of characters by which the selection was moved. + */ + moveDown(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + /** + * Moves the ending character position of the range or selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for moving end. + * @returns The number of characters by which the selection was moved. + */ + moveEnd(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + /** + * Moves the end position of the selection until any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param characters Characters to search for. For example. If you specify "a", the selection moves the end position to before the first "a" character. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveEndUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the ending character position of the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param characters Characters to search for. For example. If you specify "abcd", the selection moves the end position when any letter from "abcd" is found. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveEndWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection to the left. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for moving left. + * @returns The number of characters by which the selection was moved. + */ + moveLeft(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + /** + * Moves the selection to the right. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for moving right. + * @returns The number of characters by which the selection was moved. + */ + moveRight(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for the `moveStart` operation. + * @returns The number of characters by which the selection was moved. + */ + moveStart(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection until one of the specified characters is found in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param characters Characters to search for. If you specify "a", the selection moves the start position to before the first "a" character. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveStartUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param characters Characters to search for. For example. If you specify "abcd", the selection moves the start position when any letter from "abcd" is found. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveStartWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection until one of the specified characters is found in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param characters Characters to search for. For example. If you specify "a", the selection moves to the position before the first "a" character. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection up. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param options Optional. Options for moving up. + * @returns The number of characters by which the selection was moved. + */ + moveUp(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + /** + * Moves the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param characters Characters to search for. For example. If you specify "abcd", the selection moves to the position when any letter from "abcd" is found. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Selects the next field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * @returns The next field. + */ + nextField(): Word.Field; + /** + * Moves the selection to the next subdocument. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + nextSubdocument(): void; + /** + * Pastes the content from clipboard and formats them as specified. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param type The format paste type for table cells. + */ + pasteAndFormat(type: Word.PasteFormatType): void; + /** + * Pastes the content from clipboard and formats them as specified. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param type The format paste type for table cells. + */ + pasteAndFormat(type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"): void; + /** + * Pastes and formats a Microsoft Excel table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param linkedToExcel Whether the table is linked to Excel. + * @param wordFormatting Whether to apply Word formatting. + * @param rtf Whether to paste as Rich Text Format (RTF). + */ + pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean): void; + /** + * Applies formatting copied with the `copyFormat` method to the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pasteFormat(): void; + /** + * Merges pasted cells into an existing table by inserting the pasted rows between the selected rows. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pasteTableCellsAppendTable(): void; + /** + * Pastes a cell or group of cells as a nested table into the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pasteTableCellsAsNestedTable(): void; + /** + * Selects and returns the previous field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * @returns The previous field. + */ + previousField(): Word.Field; + /** + * Moves the selection to the previous subdocument. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + previousSubdocument(): void; + /** + * Replaces the selection with a new paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + replaceParagraph(): void; + /** + * Selects the current text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + select(): void; + /** + * Selects the entire cell containing the current selection when the selection is in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectCell(): void; + /** + * Selects the column that contains the insertion point, or selects all columns that contain the selection when the selection is in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectColumn(): void; + /** + * Extends the selection forward until text with a different paragraph alignment is encountered. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectCurrentAlignment(): void; + /** + * Extends the selection forward until text with a different color is encountered. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectCurrentColor(): void; + /** + * Extends the selection forward until text in a different font or font size is encountered. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectCurrentFont(): void; + /** + * Extends the selection forward until text with different left or right paragraph indents is encountered. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectCurrentIndent(): void; + /** + * Extends the selection forward until a paragraph with different line spacing is encountered. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectCurrentSpacing(): void; + /** + * Extends the selection forward until a paragraph with different tab stops is encountered. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectCurrentTabs(): void; + /** + * Selects the row that contains the insertion point, or selects all rows that contain the selection when the selection is in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectRow(): void; + /** + * Sets the starting and ending character positions for the selection. + Character position values start at the beginning of the story, with the first value being 0. All characters are counted, including nonprinting characters. Hidden characters are counted even if they're not displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param start The starting character position of the current story. + * @param end The ending character position of the current story. + */ + setRange(start: number, end: number): void; + /** + * Shrinks the selection to the next smaller unit of text. + The unit progression for this method is as follows: entire document, section, paragraph, sentence, word, insertion point. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shrink(): void; + /** + * Cancels the selection of all but the most recently selected text when the current selection contains multiple, unconnected selections. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shrinkDiscontiguousSelection(): void; + /** + * Inserts an empty paragraph above the first row in the selection. + If the selection isn't in the first row of the table, the table is split into two tables. If the selection isn't in a table, an error occurs. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + splitTable(): void; + /** + * Switches the selection between a Unicode character and its corresponding hexadecimal value. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + toggleCharacterCode(): void; + /** + * Deletes the character preceding the selection (if collapsed) or the insertion point. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + typeBackspace(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SelectionLoadOptions): Word.Selection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.Selection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Selection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Selection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Selection; + /** + * 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.Selection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SelectionData; + } + /** + * Represents a collection of {@link Word.Range} objects that represents each character, word, or sentence. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class RangeScopedCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Range[]; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.RangeScopedCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.RangeScopedCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RangeScopedCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.RangeScopedCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.RangeScopedCollection; + /** + * 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.RangeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.RangeScopedCollectionData; + } + /** + * Specifies the direction in which text flows from one text column to the next. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum FlowDirection { + /** + * Text flows from left to right. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + leftToRight = "LeftToRight", + /** + * Text flows from right to left. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rightToLeft = "RightToLeft", + } + /** + * Specifies where the gutter appears in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum GutterPosition { + /** + * The gutter appears on the left side of the document. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + left = "Left", + /** + * The gutter appears on the right side of the document. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + right = "Right", + /** + * The gutter appears at the top of the document. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + top = "Top", + } + /** + * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum GutterStyle { + /** + * Gutter style for bidirectional text flow. This is mainly right to left. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bidirectional = "Bidirectional", + /** + * Gutter style for Latin text flow. This is mainly left to right. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + latin = "Latin", + } + /** + * Specifies how text is laid out in the layout mode for the current document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum LayoutMode { + /** + * Default layout mode. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + default = "Default", + /** + * Grid layout mode. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + grid = "Grid", + /** + * Line grid layout mode. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lineGrid = "LineGrid", + /** + * Genko layout mode. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + genko = "Genko", + } + /** + * Specifies the numbering rule to apply. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum NumberingRule { + /** + * Restart numbering continuously. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + restartContinuous = "RestartContinuous", + /** + * Restart numbering at the beginning of each section. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + restartSection = "RestartSection", + /** + * Restart numbering at the beginning of each page. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + restartPage = "RestartPage", + } + /** + * Specifies a page layout orientation. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PageOrientation { + /** + * Portrait orientation. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + portrait = "Portrait", + /** + * Landscape orientation. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + landscape = "Landscape", + } + /** + * Specifies the type of vertical alignment to apply. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PageSetupVerticalAlignment { + /** + * Align text to the top. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + top = "Top", + /** + * Align text to the center. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + center = "Center", + /** + * Justify text vertically. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + justify = "Justify", + /** + * Align text to the bottom. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottom = "Bottom", + } + /** + * Specifies a paper size. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum PaperSize { + /** + * 10x14 paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + size10x14 = "Size10x14", + /** + * 11x17 paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + size11x17 = "Size11x17", + /** + * Letter paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + letter = "Letter", + /** + * Small letter paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + letterSmall = "LetterSmall", + /** + * Legal paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + legal = "Legal", + /** + * Executive paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + executive = "Executive", + /** + * A3 paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + a3 = "A3", + /** + * A4 paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + a4 = "A4", + /** + * Small A4 paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + a4Small = "A4Small", + /** + * A5 paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + a5 = "A5", + /** + * B4 paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + b4 = "B4", + /** + * B5 paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + b5 = "B5", + /** + * C-sheet paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + csheet = "CSheet", + /** + * D-sheet paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dsheet = "DSheet", + /** + * E-sheet paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + esheet = "ESheet", + /** + * Fanfold legal German paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fanfoldLegalGerman = "FanfoldLegalGerman", + /** + * Fanfold standard German paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fanfoldStdGerman = "FanfoldStdGerman", + /** + * Fanfold US paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fanfoldUS = "FanfoldUS", + /** + * Folio paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + folio = "Folio", + /** + * Ledger paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + ledger = "Ledger", + /** + * Note paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + note = "Note", + /** + * Quarto paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + quarto = "Quarto", + /** + * Statement paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + statement = "Statement", + /** + * Tabloid paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tabloid = "Tabloid", + /** + * Envelope size 9. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelope9 = "Envelope9", + /** + * Envelope size 10. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelope10 = "Envelope10", + /** + * Envelope size 11. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelope11 = "Envelope11", + /** + * Envelope size 12. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelope12 = "Envelope12", + /** + * Envelope size 14. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelope14 = "Envelope14", + /** + * Envelope B4 size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeB4 = "EnvelopeB4", + /** + * Envelope B5 size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeB5 = "EnvelopeB5", + /** + * Envelope B6 size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeB6 = "EnvelopeB6", + /** + * Envelope C3 size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeC3 = "EnvelopeC3", + /** + * Envelope C4 size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeC4 = "EnvelopeC4", + /** + * Envelope C5 size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeC5 = "EnvelopeC5", + /** + * Envelope C6 size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeC6 = "EnvelopeC6", + /** + * Envelope C65 size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeC65 = "EnvelopeC65", + /** + * Envelope DL size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeDL = "EnvelopeDL", + /** + * Envelope Italy size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeItaly = "EnvelopeItaly", + /** + * Envelope Monarch size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopeMonarch = "EnvelopeMonarch", + /** + * Envelope Personal size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + envelopePersonal = "EnvelopePersonal", + /** + * Custom paper size. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + custom = "Custom", + } + /** + * Specifies how Word displays the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum SectionDirection { + /** + * Right-to-left reading order. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rightToLeft = "RightToLeft", + /** + * Left-to-right reading order. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the type of section break for the specified item. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + enum SectionStart { + /** + * Continuous section break. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + continuous = "Continuous", + /** + * New column section break. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + newColumn = "NewColumn", + /** + * New page section break. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + newPage = "NewPage", + /** + * Even page section break. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + evenPage = "EvenPage", + /** + * Odd page section break. + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + oddPage = "OddPage", + } + /** + * Specifies how a table is resized to fit its contents or the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum AutoFitBehavior { + /** + * Disables automatic resizing. The table retains its current size. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fixedSize = "FixedSize", + /** + * Automatically resizes the table columns to fit the contents. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + content = "Content", + /** + * Automatically resizes the table to fit the window width. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + window = "Window", + } + /** + * Specifies the type of bidirectional calendar to use. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum CalendarTypeBidirectional { + /** + * Uses the Gregorian calendar. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gregorian = "Gregorian", + /** + * Uses the Bidirectional calendar. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bidirectional = "Bidirectional", + } + /** + * Specifies the position of a caption relative to the object it describes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum CaptionPosition { + /** + * Places the caption above the selected item. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + above = "Above", + /** + * Places the caption below the selected item. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + below = "Below", + } + /** + * Specifies the direction in which to collapse a selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum CollapseDirection { + /** + * Collapses the selection to the start position. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + start = "Start", + /** + * Collapses the selection to the end position. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + end = "End", + } + /** + * Specifies the language to use for date formatting. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum DateLanguage { + /** + * Uses the bidirectional date/time format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bidirectional = "Bidirectional", + /** + * Uses the latin date/time format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + latin = "Latin", + } + /** + * Specifies the font bias to use when formatting East Asian text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum FontBias { + /** + * Uses the default font bias. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + standard = "Standard", + /** + * Uses the font bias for Far East text. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + farEast = "FarEast", + /** + * No font bias specified. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + noSpecified = "NoSpecified", + } + /** + * Specifies the direction in which to move when using the {@link Word.Selection | Selection.goTo} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum GoToDirection { + /** + * Moves to the first item. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + first = "First", + /** + * Moves to the last item. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + last = "Last", + /** + * Moves to the next item. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + next = "Next", + /** + * Moves to the previous item. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + previous = "Previous", + } + /** + * Specifies the item or location to which to move or extend a {@link Word.Selection | selection}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum GoToItem { + /** + * Moves to a bookmark. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bookmark = "Bookmark", + /** + * Moves to a comment. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + comment = "Comment", + /** + * Moves to a endnote. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnote = "Endnote", + /** + * Moves to a field. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + field = "Field", + /** + * Moves to a footnote. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnote = "Footnote", + /** + * Moves to a graphic. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + graphic = "Graphic", + /** + * Moves to a heading. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + heading = "Heading", + /** + * Moves to a line. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + line = "Line", + /** + * Moves to a page. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + page = "Page", + /** + * Moves to a section. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + section = "Section", + /** + * Moves to a table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + table = "Table", + /** + * Moves to an embedded object. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + embeddedObject = "EmbeddedObject", + /** + * Moves to an equation. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + equation = "Equation", + /** + * Moves to a percent. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + percent = "Percent", + /** + * Moves to a spelling error. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + spellingError = "SpellingError", + /** + * Moves to a grammatical error. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + grammaticalError = "GrammaticalError", + /** + * Moves to a proofreading error. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + proofreadingError = "ProofreadingError", + } + /** + * Specifies the type of movement when navigating through a document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum MovementType { + /** + * Moves the insertion point or selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + move = "Move", + /** + * Extends the selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + extend = "Extend", + } + /** + * Specifies the unit of measurement used in Word operations. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum OperationUnit { + /** + * Specifies a character unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + character = "Character", + /** + * Specifies a word unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + word = "Word", + /** + * Specifies a sentence unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sentence = "Sentence", + /** + * Specifies a paragraph unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + paragraph = "Paragraph", + /** + * Specifies a line unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + line = "Line", + /** + * Specifies a story unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + story = "Story", + /** + * Specifies a screen unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + screen = "Screen", + /** + * Specifies a section unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + section = "Section", + /** + * Specifies a column unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + column = "Column", + /** + * Specifies a row unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + row = "Row", + /** + * Specifies a window unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + window = "Window", + /** + * Specifies a cell unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + cell = "Cell", + /** + * Specifies a character format unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + characterFormat = "CharacterFormat", + /** + * Specifies a paragraph format unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + paragraphFormat = "ParagraphFormat", + /** + * Specifies a table unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + table = "Table", + /** + * Specifies an item unit. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + item = "Item", + } + /** + * Specifies the type of formatting when paste to a document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum PasteFormatType { + /** + * Uses the default paste behavior. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pasteDefault = "PasteDefault", + /** + * Pastes text into a single cell. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + singleCellText = "SingleCellText", + /** + * Pastes a table into a single cell. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + singleCellTable = "SingleCellTable", + /** + * Continues numbering from the previous list. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + listContinueNumbering = "ListContinueNumbering", + /** + * Restarts numbering for the new list. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + listRestartNumbering = "ListRestartNumbering", + /** + * Appends the pasted table to the existing table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tableAppendTable = "TableAppendTable", + /** + * Inserts the pasted table as new rows. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tableInsertAsRows = "TableInsertAsRows", + /** + * Inserts the pasted table with its original formatting. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tableOriginalFormatting = "TableOriginalFormatting", + /** + * Pastes a chart as a picture. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + chartPicture = "ChartPicture", + /** + * Pastes a chart as an editable chart. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + chart = "Chart", + /** + * Pastes a chart with a link to the source data. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + chartLinked = "ChartLinked", + /** + * Applies the original formatting of the pasted content. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formatOriginalFormatting = "FormatOriginalFormatting", + /** + * Applies surrounding formatting with emphasis. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formatSurroundingFormattingWithEmphasis = "FormatSurroundingFormattingWithEmphasis", + /** + * Pastes content as plain text. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formatPlainText = "FormatPlainText", + /** + * Overwrites existing cells with the pasted table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tableOverwriteCells = "TableOverwriteCells", + /** + * Combines the pasted list with an existing list. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + listCombineWithExistingList = "ListCombineWithExistingList", + /** + * Prevents merging the pasted list with an existing list. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + listDontMerge = "ListDontMerge", + /** + * Uses the destination styles for the pasted content. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + useDestinationStylesRecovery = "UseDestinationStylesRecovery", + } + /** + * Specifies the type of reference to insert. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ReferenceType { + /** + * Refers to a numbered item in the document. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + numberedItem = "NumberedItem", + /** + * Refers to a heading in the document. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + heading = "Heading", + /** + * Refers to a bookmark in the document. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bookmark = "Bookmark", + /** + * Refers to a footnote in the document. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnote = "Footnote", + /** + * Refers to an endnote in the document. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnote = "Endnote", + } + /** + * Specifies the type of selection in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum SelectionType { + /** + * No selection is made. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + noSelection = "NoSelection", + /** + * Represents an insertion point (IP) selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + insertionPoint = "InsertionPoint", + /** + * Represents a normal selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + normal = "Normal", + /** + * Represents a frame selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + frame = "Frame", + /** + * Represents a column selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + column = "Column", + /** + * Represents a row selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + row = "Row", + /** + * Represents a block selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + block = "Block", + /** + * Represents an inline shape selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + inlineShape = "InlineShape", + /** + * Represents a shape selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selectionShape = "SelectionShape", + } + /** + * Specifies the type of field to sort by. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum SortFieldType { + /** + * Sorts content alphanumerically. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + alphanumeric = "Alphanumeric", + /** + * Sorts content numerically. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + numeric = "Numeric", + /** + * Sorts content by date. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + date = "Date", + /** + * Sorts content by syllables. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + syllable = "Syllable", + /** + * Sorts content using the Japanese JIS standard. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + japanJis = "JapanJis", + /** + * Sorts content by stroke count. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + stroke = "Stroke", + /** + * Sorts content using the Korean KS standard. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + koreaKs = "KoreaKs", + } + /** + * Specifies the sort order. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum SortOrder { + /** + * Sorts in ascending order. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + ascending = "Ascending", + /** + * Sorts in descending order. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + descending = "Descending", + } + /** + * Specifies where and what type of cells to add to an existing table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum TableCellInsertionLocation { + /** + * Inserts new cells to the left of the selected cells. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shiftRight = "ShiftRight", + /** + * Inserts new cells above the selected cells. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shiftDown = "ShiftDown", + /** + * Inserts an entire row above the row that contains the selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shiftRowDown = "ShiftRowDown", + /** + * Inserts an entire column to the left of the column that contains the selection. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shiftColumnRight = "ShiftColumnRight", + } + /** + * Specifies the orientation of text in a text frame or shape. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum TextOrientation { + /** + * Text is horizontal. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + horizontal = "Horizontal", + /** + * Text is vertical with letters rotated 90 degrees clockwise. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + upward = "Upward", + /** + * Text is vertical with letters rotated 90 degrees counterclockwise. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + downward = "Downward", + /** + * Text is vertical and reads downward from the top, right to left. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + verticalFarEast = "VerticalFarEast", + /** + * Text is horizontal but from right to left to accommodate right-to-left languages. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + horizontalRotatedFarEast = "HorizontalRotatedFarEast", + /** + * Text is vertical and reads downward from the top, left to right. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + vertical = "Vertical", + } + /** + * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. + The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class Bookmark extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly range: Word.Range; + /** + * Specifies the ending character position of the bookmark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + end: number; + /** + * Returns `true` if the bookmark is a table column. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly isColumn: boolean; + /** + * Returns `true` if the bookmark is empty. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly isEmpty: boolean; + /** + * Returns the name of the `Bookmark` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly name: string; + /** + * Specifies the starting character position of the bookmark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + start: number; + /** + * Returns the story type for the bookmark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.BookmarkUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Bookmark): void; + /** + * Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param name The name of the new bookmark. + */ + copyTo(name: string): Word.Bookmark; + /** + * Deletes the bookmark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + delete(): void; + /** + * Selects the bookmark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + select(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.BookmarkLoadOptions): Word.Bookmark; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.Bookmark; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Bookmark; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Bookmark; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Bookmark; + /** + * 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.Bookmark` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.BookmarkData; + } + /** + * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class BookmarkCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Bookmark[]; + /** + * Determines whether the specified bookmark exists. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param name A bookmark name than cannot include more than 40 characters or more than one word. + * @returns `true` if the bookmark exists. + */ + exists(name: string): OfficeExtension.ClientResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.BookmarkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BookmarkCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.BookmarkCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.BookmarkCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.BookmarkCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.BookmarkCollection; + /** + * 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.BookmarkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.BookmarkCollectionData; + } + /** + * Specifies the type of story in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum StoryType { + /** + * Main text story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + mainText = "MainText", + /** + * Footnotes story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnotes = "Footnotes", + /** + * Endnotes story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnotes = "Endnotes", + /** + * Comments story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + comments = "Comments", + /** + * Text frame story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + textFrame = "TextFrame", + /** + * Even pages header story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + evenPagesHeader = "EvenPagesHeader", + /** + * Primary header story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + primaryHeader = "PrimaryHeader", + /** + * Even pages footer story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + evenPagesFooter = "EvenPagesFooter", + /** + * Primary footer story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + primaryFooter = "PrimaryFooter", + /** + * First page header story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + firstPageHeader = "FirstPageHeader", + /** + * First page footer story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + firstPageFooter = "FirstPageFooter", + /** + * Footnote separator story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnoteSeparator = "FootnoteSeparator", + /** + * Footnote continuation separator story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnoteContinuationSeparator = "FootnoteContinuationSeparator", + /** + * Footnote continuation notice story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + footnoteContinuationNotice = "FootnoteContinuationNotice", + /** + * Endnote separator story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnoteSeparator = "EndnoteSeparator", + /** + * Endnote continuation separator story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnoteContinuationSeparator = "EndnoteContinuationSeparator", + /** + * Endnote continuation notice story. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + endnoteContinuationNotice = "EndnoteContinuationNotice", + } + /** + * Represents a single index. The `Index` object is a member of the {@link Word.IndexCollection}. The `IndexCollection` includes all the + indexes in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class Index extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `Range` object that represents the portion of the document that is contained within the index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly range: Word.Range; + /** + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + /** + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + /** + * Gets a `LanguageId` value that represents the sorting language to use for the index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Gets the number of columns for each page of the index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly numberOfColumns: number; + /** + * Specifies if page numbers are aligned with the right margin in the index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly rightAlignPageNumbers: boolean; + /** + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly separateAccentedLetterHeadings: boolean; + /** + * Specifies the sorting criteria for the index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * Specifies the leader character between entries in the index and their associated page numbers. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + /** + * Gets the index type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly type: Word.IndexType | "Indent" | "Runin"; + /** + * 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. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.IndexUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Index): void; + /** + * Deletes this index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + delete(): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.IndexLoadOptions): Word.Index; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.Index; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Index; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Index; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.Index; + /** + * 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.Index` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.IndexData; + } + /** + * A collection of {@link Word.Index} objects that represents all the indexes in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class IndexCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.Index[]; + /** + * Returns an `Index` object that represents a new index added to the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param range The range where you want the index to appear. The index replaces the range, if the range is not collapsed. + * @param indexAddOptions Optional. The options for adding the index. + */ + add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index; + /** + * Gets the `IndexFormat` value that represents the formatting for the indexes in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + getFormat(): OfficeExtension.ClientResult; + /** + * Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param range The range whose text is marked with an `XE` field throughout the document. + * @param markAllEntriesOptions Optional. The options for marking all entries. + */ + markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.IndexCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.IndexCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.IndexCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.IndexCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.IndexCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.IndexCollection; + /** + * 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.IndexCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.IndexCollectionData; + } + /** + * Represents options for creating an index in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface IndexAddOptions { + /** + * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. + See `HeadingSeparator` for available values. The default value is `blankLine`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + /** + * If provided, specifies the sorting language to be used for the index being added. + See `LanguageId` for available values. The default value is the installed language of the Word application. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * If provided, specifies the number of columns for each page of the index. + Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + numberOfColumns?: number; + /** + * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + rightAlignPageNumbers?: boolean; + /** + * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + separateAccentedLetterHeadings?: boolean; + /** + * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `stroke`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. + Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `indent`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: Word.IndexType | "Indent" | "Runin"; + } + /** + * Represents options for marking all index entries in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface IndexMarkAllEntriesOptions { + /** + * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bold?: boolean; + /** + * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bookmarkName?: string; + /** + * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + crossReference?: string; + /** + * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + crossReferenceAutoText?: string; + /** + * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". + Either this property or `entryAutoText` must be provided. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + entry?: string; + /** + * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". + Either this property or `entry` must be provided. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + entryAutoText?: string; + /** + * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + italic?: boolean; + } + /** + * Specifies the type of separator to use for headings. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum HeadingSeparator { + /** + * No separator is used for headings. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * A blank line is used as a separator for headings. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + blankLine = "BlankLine", + /** + * A single letter is used as a separator for headings. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + letter = "Letter", + /** + * A lowercase letter is used as a separator for headings. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + letterLow = "LetterLow", + /** + * A full-width letter is used as a separator for headings. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + letterFull = "LetterFull", + } + /** + * Represents the position of a dropped capital letter. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum DropPosition { + /** + * Represents that there's no dropped capital letter. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * Represents a normal dropped capital letter. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + normal = "Normal", + /** + * Represents a dropped capital letter in the margin. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + margin = "Margin", + } + /** + * Represents the alignment of a tab stop. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum TabAlignment { + /** + * Represents that the tab stop is aligned to the left. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + left = "Left", + /** + * Represents that the tab stop is aligned to the center. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + center = "Center", + /** + * Represents that the tab stop is aligned to the right. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + right = "Right", + /** + * Represents that the tab stop is aligned to the decimal point. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + decimal = "Decimal", + /** + * Represents that the tab stop is aligned to the bar. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bar = "Bar", + /** + * Represents that the tab stop is aligned to the list. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + list = "List", + } + /** + * Specifies the filter type for an index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum IndexFilter { + /** + * No filter is applied. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * Aiueo filter is applied. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + aiueo = "Aiueo", + /** + * Akasatana filter is applied. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + akasatana = "Akasatana", + /** + * Chosung filter is applied. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + chosung = "Chosung", + /** + * Low filter is applied. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + low = "Low", + /** + * Medium filter is applied. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + medium = "Medium", + /** + * Full filter is applied. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + full = "Full", + } + /** + * Specifies the format for an index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum IndexFormat { + /** + * Template format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + template = "Template", + /** + * Classic format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + classic = "Classic", + /** + * Fancy format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fancy = "Fancy", + /** + * Modern format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + modern = "Modern", + /** + * Bulleted format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bulleted = "Bulleted", + /** + * Formal format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formal = "Formal", + /** + * Simple format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + simple = "Simple", + } + /** + * Specifies how an index is sorted. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum IndexSortBy { + /** + * Sort by stroke. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + stroke = "Stroke", + /** + * Sort by syllable. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + syllable = "Syllable", + } + /** + * Specifies the type of index to create. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum IndexType { + /** + * Creates an indented index. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + indent = "Indent", + /** + * Creates a run-in index. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + runin = "Runin", + } + /** + * Specifies the tab leader style. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum TabLeader { + /** + * Spaces are used as the tab leader. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + spaces = "Spaces", + /** + * Dots are used as the tab leader. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + dots = "Dots", + /** + * Dashes are used as the tab leader. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + dashes = "Dashes", + /** + * Lines are used as the tab leader. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + lines = "Lines", + /** + * Heavy lines are used as the tab leader. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + heavy = "Heavy", + /** + * Middle dots are used as the tab leader. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + middleDot = "MiddleDot", + } + /** + * Specifies the area of a table to which to apply special style formatting. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ConditionCode { + /** + * Applies formatting to the first row in a table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + firstRow = "FirstRow", + /** + * Applies formatting to the last row in a table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + lastRow = "LastRow", + /** + * Applies formatting to odd-numbered rows. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + oddRowBanding = "OddRowBanding", + /** + * Applies formatting to even-numbered rows. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + evenRowBanding = "EvenRowBanding", + /** + * Applies formatting to the first column in a table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + firstColumn = "FirstColumn", + /** + * Applies formatting to the last column in a table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + lastColumn = "LastColumn", + /** + * Applies formatting to odd-numbered columns. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + oddColumnBanding = "OddColumnBanding", + /** + * Applies formatting to even-numbered columns. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + evenColumnBanding = "EvenColumnBanding", + /** + * Applies formatting to the last cell in the first row. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + topRightCell = "TopRightCell", + /** + * Applies formatting to the first cell in the first row. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + topLeftCell = "TopLeftCell", + /** + * Applies formatting to the last cell in the table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bottomRightCell = "BottomRightCell", + /** + * Applies formatting to first cell in the last row of the table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bottomLeftCell = "BottomLeftCell", + } + /** + * Specifies a range of cells to be deleted from a table in a delete cells action or the behavior of the remaining cells after the deletion has occurred. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum DeleteCells { + /** + * Shift remaining cells left in the row where the deletion occurred after a cell or range of cells has been deleted. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shiftLeft = "ShiftLeft", + /** + * Shift remaining cells up in the column where the deletion occurred after a cell or range of cells has been deleted. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shiftUp = "ShiftUp", + /** + * Delete the entire row of cells from the table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + entireRow = "EntireRow", + /** + * Delete the entire column of cells from the table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + entireColumn = "EntireColumn", + } + /** + * Specifies the rule for determining the height of the specified cells or rows. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum RowHeightRule { + /** + * The row height is adjusted to accommodate the tallest value in the row. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + auto = "Auto", + /** + * The row height is set to a minimum value. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + atLeast = "AtLeast", + /** + * The row height is set to an exact value. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + exactly = "Exactly", + } + /** + * Specifies the direction in which Microsoft Word orders cells in the specified table or row. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum TableDirection { + /** + * The table is arranged with the first column in the rightmost position. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + rightToLeft = "RightToLeft", + /** + * The table is arranged with the first column in the leftmost position. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the character used to separate fields in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum TableFieldSeparator { + /** + * Uses the paragraph marker. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + paragraph = "Paragraph", + /** + * Uses the tab. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tab = "Tab", + /** + * Uses the comma. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + comma = "Comma", + /** + * Uses the default list separator. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + defaultListSeparator = "DefaultListSeparator", + } + /** + * Specifies the table format to apply. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum TableFormatType { + /** + * Applies no formatting to the table. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * Applies the Simple1 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + simple1 = "Simple1", + /** + * Applies the Simple2 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + simple2 = "Simple2", + /** + * Applies the Simple3 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + simple3 = "Simple3", + /** + * Applies the Classic1 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + classic1 = "Classic1", + /** + * Applies the Classic2 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + classic2 = "Classic2", + /** + * Applies the Classic3 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + classic3 = "Classic3", + /** + * Applies the Classic4 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + classic4 = "Classic4", + /** + * Applies the Colorful1 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + colorful1 = "Colorful1", + /** + * Applies the Colorful2 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + colorful2 = "Colorful2", + /** + * Applies the Colorful3 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + colorful3 = "Colorful3", + /** + * Applies the Columns1 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + columns1 = "Columns1", + /** + * Applies the Columns2 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + columns2 = "Columns2", + /** + * Applies the Columns3 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + columns3 = "Columns3", + /** + * Applies the Columns4 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + columns4 = "Columns4", + /** + * Applies the Columns5 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + columns5 = "Columns5", + /** + * Applies the Grid1 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + grid1 = "Grid1", + /** + * Applies the Grid2 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + grid2 = "Grid2", + /** + * Applies the Grid3 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + grid3 = "Grid3", + /** + * Applies the Grid4 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + grid4 = "Grid4", + /** + * Applies the Grid5 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + grid5 = "Grid5", + /** + * Applies the Grid6 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + grid6 = "Grid6", + /** + * Applies the Grid7 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + grid7 = "Grid7", + /** + * Applies the Grid8 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + grid8 = "Grid8", + /** + * Applies the List1 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + list1 = "List1", + /** + * Applies the List2 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + list2 = "List2", + /** + * Applies the List3 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + list3 = "List3", + /** + * Applies the List4 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + list4 = "List4", + /** + * Applies the List5 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + list5 = "List5", + /** + * Applies the List6 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + list6 = "List6", + /** + * Applies the List7 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + list7 = "List7", + /** + * Applies the List8 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + list8 = "List8", + /** + * Applies the 3D Effects1 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + threeDEffects1 = "ThreeDEffects1", + /** + * Applies the 3D Effects2 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + threeDEffects2 = "ThreeDEffects2", + /** + * Applies the 3D Effects3 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + threeDEffects3 = "ThreeDEffects3", + /** + * Applies the Contemporary table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + contemporary = "Contemporary", + /** + * Applies the Elegant table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + elegant = "Elegant", + /** + * Applies the Professional table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + professional = "Professional", + /** + * Applies the Subtle1 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + subtle1 = "Subtle1", + /** + * Applies the Subtle2 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + subtle2 = "Subtle2", + /** + * Applies the Web1 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + web1 = "Web1", + /** + * Applies the Web2 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + web2 = "Web2", + /** + * Applies the Web3 table format. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + web3 = "Web3", + } + /** + * Represents the options for the {@link Word.Table | Table.autoFormat} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TableAutoFormatOptions { + /** + * If provided, specifies whether to apply borders of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + applyBorders?: boolean; + /** + * If provided, specifies whether to apply color of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + applyColor?: boolean; + /** + * If provided, specifies whether to apply first column formatting of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + applyFirstColumn?: boolean; + /** + * If provided, specifies whether to apply font of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + applyFont?: boolean; + /** + * If provided, specifies whether to apply heading row formatting of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + applyHeadingRows?: boolean; + /** + * If provided, specifies whether to apply last column formatting of the specified format. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + applyLastColumn?: boolean; + /** + * If provided, specifies whether to apply last row formatting of the specified format. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + applyLastRow?: boolean; + /** + * If provided, specifies whether to apply shading of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + applyShading?: boolean; + /** + * If provided, specifies whether to decrease the width of the table columns as much as possible without changing the way text wraps in the cells. The default value is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + autoFit?: boolean; + /** + * If provided, specifies the format to apply. The default value is `simple1`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + format?: Word.TableFormatType | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; + } + /** + * Represents the options for the {@link Word.TableCellCollection | TableCellCollection.split} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TableCellCollectionSplitOptions { + /** + * If provided, specifies whether to merge the cells with one another before splitting them. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + mergeBeforeSplit?: boolean; + /** + * If provided, specifies the number of columns that the group of cells is to be split into. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + numColumns?: number; + /** + * If provided, specifies the number of rows that the group of cells is to be split into. The default value is 1. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + numRows?: number; + } + /** + * Represents the options for the {@link Word.TableCell | TableCell.formula} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TableCellFormulaOptions { + /** + * If provided, specifies the mathematical formula you want the = (Formula) field to evaluate. Spreadsheet-type references to table cells are valid. For example, "=SUM(A4:C4)" specifies the first three values in the fourth row. For more information about the = (Formula) field, see {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Field codes: = (Formula) field}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formula?: string; + /** + * If provided, specifies a format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}. For information about the types of formats you can apply, see the Numeric Picture (#) field switch. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + numFormat?: string; + } + /** + * Represents the options for the {@link Word.Table | Table.convertToText}, {@link Word.TableRow | TableRow.convertToText}, and {@link Word.TableRowCollection | TableRowCollection.convertToText} methods. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TableConvertToTextOptions { + /** + * If provided, specifies whether to convert the nested tables to text. This property is ignored if the `separator` property isn't set to `paragraph`. The default is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + nestedTables?: boolean; + /** + * If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows). The default is `tab`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + separator?: Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | "DefaultListSeparator"; + } + /** + * Represents the options for the {@link Word.Table | Table.sort} method. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TableSortOptions { + /** + * If provided, specifies whether to use bidirectional sort. `true` means to sort based on right-to-left language rules. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bidirectionalSort?: boolean; + /** + * If provided, specifies whether sorting is case-sensitive. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + caseSensitive?: boolean; + /** + * If provided, specifies whether to exclude the header row from the sort operation. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + excludeHeader?: boolean; + /** + * If provided, specifies the first field to sort by. Microsoft Word sorts by `fieldNumber`, then by `fieldNumber2`, and finally by `fieldNumber3`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fieldNumber?: string; + /** + * If provided, specifies the second field to sort by. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fieldNumber2?: string; + /** + * If provided, specifies the third field to sort by. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fieldNumber3?: string; + /** + * If provided, specifies whether to ignore Arabic character alef lam when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + ignoreArabicThe?: boolean; + /** + * If provided, specifies whether to ignore bidirectional control characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + ignoreDiacritics?: boolean; + /** + * If provided, specifies whether to ignore Hebrew characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + ignoreHebrew?: boolean; + /** + * If provided, specifies whether to ignore kashida when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + ignoreKashida?: boolean; + /** + * If provided, specifies the sorting language. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * If provided, specifies the type of the first field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sortFieldType?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the type of the second field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sortFieldType2?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the type of the third field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sortFieldType3?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the sort order of the first field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sortOrder?: Word.SortOrder | "Ascending" | "Descending"; + /** + * If provided, specifies the sort order of the second field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sortOrder2?: Word.SortOrder | "Ascending" | "Descending"; + /** + * If provided, specifies the sort order of the third field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sortOrder3?: Word.SortOrder | "Ascending" | "Descending"; + } + /** + * Represents a list of the names of all the available fonts. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class FontNameCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns the number of items in the collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the font name at the specified index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param index The zero-based index of the item to retrieve. + */ + getItemAt(index: number): OfficeExtension.ClientResult; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.FontNameCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.FontNameCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.FontNameCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.FontNameCollection; + /** + * 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.FontNameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontNameCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class ListTemplateCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.ListTemplate[]; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.ListTemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListTemplateCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ListTemplateCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListTemplateCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListTemplateCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListTemplateCollection; + /** + * 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.ListTemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListTemplateCollectionData; + } + /** + * Represents a gallery of list templates of the same {@link Word.ListTemplateGalleryType}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class ListTemplateGallery extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * Returns a `ListTemplateCollection` object that represents all the list templates for the specified list gallery. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readonly listTemplates: Word.ListTemplateCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ListTemplateGallery; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListTemplateGallery; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListTemplateGallery; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListTemplateGallery; + /** + * 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.ListTemplateGallery` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListTemplateGalleryData; + } + /** + * Contains a collection of {@link Word.ListTemplateGallery} objects available through the three bullets-and-numbering buttons on the **Home** tab (see {@link https://support.microsoft.com/office/6c06ef65-27ad-4893-80c9-0b944cb81f5f | Define new bullets, numbers, and multilevel lists} for how to access in the Word UI). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + class ListTemplateGalleryCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Word.ListTemplateGallery[]; + /** + * Gets a `ListTemplateGallery` object by its type in the collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param type The type of list template gallery to retrieve. + */ + getByType(type: Word.ListTemplateGalleryType): Word.ListTemplateGallery; + /** + * Gets a `ListTemplateGallery` object by its type in the collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + * + * @param type The type of list template gallery to retrieve. + */ + getByType(type: "Bullets" | "Number" | "OutlineNumbered"): Word.ListTemplateGallery; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.ListTemplateGalleryCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListTemplateGalleryCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListTemplateGalleryCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | 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.ListTemplateGalleryCollection; + /** + * 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.ListTemplateGalleryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListTemplateGalleryCollectionData; + } + /** + * Describes the types of list template galleries available. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum ListTemplateGalleryType { + /** + * Represents the bullet list gallery. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bullets = "Bullets", + /** + * Represents the number list gallery. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + number = "Number", + /** + * Represents the outline number list gallery. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + outlineNumbered = "OutlineNumbered", + } + /** + * Represents the types of {@link Word.CoauthoringLock | coauthoring locks}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum CoauthoringLockType { + /** + * Reserved for future use. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + none = "None", + /** + * Represents that the lock is a reservation. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + reservation = "Reservation", + /** + * Represents that the lock is ephemeral. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + ephemeral = "Ephemeral", + /** + * Represents that the lock has changed. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + changed = "Changed", + } + /** + * Represents the classes of users who can edit authorized portions of a protected (read-only) document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + enum EditorType { + /** + * Represents the current user of the document. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + current = "Current", + /** + * Represents the Editors group for documents that use Information Rights Management. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + editors = "Editors", + /** + * Represents all users who open a document. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + everyone = "Everyone", + /** + * Represents the Owners group for documents that use Information Rights Management. + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + owners = "Owners", + } + enum ErrorCodes { + accessDenied = "AccessDenied", + generalException = "GeneralException", + invalidArgument = "InvalidArgument", + itemNotFound = "ItemNotFound", + notAllowed = "NotAllowed", + notImplemented = "NotImplemented", + searchDialogIsOpen = "SearchDialogIsOpen", + searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", + } + namespace Interfaces { + /** + * Provides ways to load properties of only a subset of members of a collection. + */ + interface CollectionLoadOptions { + /** + * Specify the number of items in the queried collection to be included in the result. + */ + $top?: number; + /** + * Specify the number of items in the collection that are to be skipped and not included in the result. If `top` is specified, the selection of result will start after skipping the specified number of items. + */ + $skip?: number; + } + /** An interface for updating data on the `Editor` object, for use in `editor.set({ ... })`. */ + interface EditorUpdateData { + /** + * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + nextRange?: Word.Interfaces.RangeUpdateData; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `ConflictCollection` object, for use in `conflictCollection.set({ ... })`. */ + interface ConflictCollectionUpdateData { + items?: Word.Interfaces.ConflictData[]; + } + /** An interface for updating data on the `Conflict` object, for use in `conflict.set({ ... })`. */ + interface ConflictUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ + interface AnnotationCollectionUpdateData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ + interface ApplicationUpdateData { + /** + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * Specifies if Microsoft Word automatically detects the language you are using as you type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + checkLanguage?: boolean; + } + /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ + interface BodyUpdateData { + /** + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ + interface BorderUpdateData { + /** + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + color?: string; + /** + * Specifies the border type for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + visible?: boolean; + /** + * Specifies the width for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + } + /** An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`. */ + interface BorderUniversalUpdateData { + /** + * Specifies the graphical page-border design for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + /** + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + artWidth?: number; + /** + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + color?: string; + /** + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isVisible?: boolean; + /** + * Specifies the line style of the border. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + /** + * Specifies the line width of an object's border. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + } + /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ + interface BorderCollectionUpdateData { + /** + * Specifies the 24-bit color of the inside borders. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderColor?: string; + /** + * Specifies the border type of the inside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width of the inside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + /** + * Specifies the 24-bit color of the outside borders. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderColor?: string; + /** + * Specifies the border type of the outside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width of the outside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + items?: Word.Interfaces.BorderData[]; + } + /** An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`. */ + interface BorderUniversalCollectionUpdateData { + items?: Word.Interfaces.BorderUniversalData[]; + } + /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ + interface BreakUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ + interface BreakCollectionUpdateData { + items?: Word.Interfaces.BreakData[]; + } + /** An interface for updating data on the `BuildingBlock` object, for use in `buildingBlock.set({ ... })`. */ + interface BuildingBlockUpdateData { + /** + * Specifies the description for the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + description?: string; + /** + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + /** + * Specifies the name of the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + name?: string; + /** + * Specifies the contents of the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + value?: string; + } + /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ + interface CheckboxContentControlUpdateData { + /** + * Specifies the current state of the checkbox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + isChecked?: boolean; + } + /** An interface for updating data on the `CoauthoringLock` object, for use in `coauthoringLock.set({ ... })`. */ + interface CoauthoringLockUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `CoauthoringLockCollection` object, for use in `coauthoringLockCollection.set({ ... })`. */ + interface CoauthoringLockCollectionUpdateData { + items?: Word.Interfaces.CoauthoringLockData[]; + } + /** An interface for updating data on the `CoauthorCollection` object, for use in `coauthorCollection.set({ ... })`. */ + interface CoauthorCollectionUpdateData { + items?: Word.Interfaces.CoauthorData[]; + } + /** An interface for updating data on the `CoauthoringUpdate` object, for use in `coauthoringUpdate.set({ ... })`. */ + interface CoauthoringUpdateUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `CoauthoringUpdateCollection` object, for use in `coauthoringUpdateCollection.set({ ... })`. */ + interface CoauthoringUpdateCollectionUpdateData { + items?: Word.Interfaces.CoauthoringUpdateData[]; + } + /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ + interface CommentUpdateData { + /** + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + /** + * Specifies the comment thread's status. Setting to `true` resolves the comment thread. Getting a value of `true` means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; + } + /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ + interface CommentCollectionUpdateData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ + interface CommentContentRangeUpdateData { + /** + * Specifies a value that indicates whether the comment text is bold. + * + * @remarks + * [Api set: WordApi 1.4] + */ + bold?: boolean; + /** + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + hyperlink?: string; + /** + * Specifies a value that indicates whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic?: boolean; + /** + * Specifies a value that indicates whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough?: boolean; + /** + * Specifies a value that indicates the comment text's underline type. `none` if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ + interface CommentReplyUpdateData { + /** + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentUpdateData; + /** + * Specifies the comment reply's content. The string is plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + } + /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ + interface CommentReplyCollectionUpdateData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface for updating data on the `ConditionalStyle` object, for use in `conditionalStyle.set({ ... })`. */ + interface ConditionalStyleUpdateData { + /** + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bottomPadding?: number; + /** + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + leftPadding?: number; + /** + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + rightPadding?: number; + /** + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + topPadding?: number; + } + /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ + interface XmlMappingUpdateData { + /** + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; + } + /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ + interface CustomXmlPrefixMappingCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPrefixMappingData[]; + } + /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ + interface CustomXmlSchemaCollectionUpdateData { + items?: Word.Interfaces.CustomXmlSchemaData[]; + } + /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ + interface CustomXmlNodeCollectionUpdateData { + items?: Word.Interfaces.CustomXmlNodeData[]; + } + /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ + interface CustomXmlNodeUpdateData { + /** + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + /** + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Specifies the value of the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nodeValue?: string; + /** + * Specifies the text for the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + text?: string; + } + /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ + interface ContentControlUpdateData { + /** + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; + /** + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ + checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; + /** + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; + /** + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + /** + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + /** + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + /** + * Specifies the appearance of the content control. The value can be `boundingBox`, `tags`, or `hidden`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotDelete?: boolean; + /** + * Specifies a value that indicates whether the user can edit the contents of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotEdit?: boolean; + /** + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText?: string; + /** + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited?: boolean; + /** + * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the `styleBuiltIn` property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the `style` property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag?: string; + /** + * Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title?: string; + } + /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ + interface ContentControlCollectionUpdateData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ + interface ContentControlListItemUpdateData { + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; + } + /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ + interface ContentControlListItemCollectionUpdateData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ + interface CustomPropertyUpdateData { + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: any; + } + /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ + interface CustomPropertyCollectionUpdateData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ + interface CustomXmlPartUpdateData { + /** + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; + } + /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ + interface CustomXmlPartCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ + interface CustomXmlPartScopedCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ + interface DocumentUpdateData { + /** + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activeWindow?: Word.Interfaces.WindowUpdateData; + /** + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesUpdateData; + /** + * Specifies whether grammatical errors are marked by a wavy green line in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areGrammaticalErrorsShown?: boolean; + /** + * Specifies whether to use the default math settings when creating new equations. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areMathDefaultsUsed?: boolean; + /** + * Specifies whether to disable features introduced after a specified version. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areNewerFeaturesDisabled?: boolean; + /** + * Specifies whether Microsoft Word underlines spelling errors in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areSpellingErrorsShown?: boolean; + /** + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areStylesUpdatedOnOpen?: boolean; + /** + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areTrueTypeFontsEmbedded?: boolean; + /** + * Specifies if automatic hyphenation is turned on for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + autoHyphenation?: boolean; + /** + * Specifies if the edits in the document are automatically saved. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + autoSaveOn?: boolean; + /** + * Specifies the ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + /** + * Specifies the maximum number of consecutive lines that can end with hyphens. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + consecutiveHyphensLimit?: number; + /** + * Specifies the interval (in points) between the default tab stops in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + defaultTabStop?: number; + /** + * Specifies the browser frame for displaying a webpage via hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + defaultTargetFrame?: string; + /** + * Specifies whether Word should not embed common system fonts. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + doNotEmbedSystemFonts?: boolean; + /** + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + encryptionProvider?: string; + /** + * Specifies the East Asian language used for line breaking. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + /** + * Specifies the line break control level. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + /** + * Specifies whether Word shows the next heading level when the previous is used. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formattingIsNextLevelShown?: boolean; + /** + * Specifies whether to show user-defined styles. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formattingIsUserStyleNameShown?: boolean; + /** + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridDistanceHorizontal?: number; + /** + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridDistanceVertical?: number; + /** + * Specifies whether the character grid starts from the upper-left corner of the page. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridIsOriginFromMargin?: boolean; + /** + * Specifies the horizontal origin point for the invisible grid. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridOriginHorizontal?: number; + /** + * Specifies the vertical origin point for the invisible grid. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridOriginVertical?: number; + /** + * Specifies the interval for horizontal character gridlines in print layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridSpaceBetweenHorizontalLines?: number; + /** + * Specifies the interval for vertical character gridlines in print layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridSpaceBetweenVerticalLines?: number; + /** + * Specifies whether words in all capital letters can be hyphenated. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hyphenateCaps?: boolean; + /** + * Specifies the width of the hyphenation zone, in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + hyphenationZone?: number; + /** + * Specifies whether automatic formatting options override formatting restrictions. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isAutoFormatOverrideOn?: boolean; + /** + * Specifies whether charts in the active document use cell-reference data-point tracking. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isChartDataPointTracked?: boolean; + /** + * Specifies whether the compatibility option specified by the `type` property is enabled. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isCompatible?: boolean; + /** + * Specifies whether the document is final. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFinal?: boolean; + /** + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFontsSubsetSaved?: boolean; + /** + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFormsDataPrinted?: boolean; + /** + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFormsDataSaved?: boolean; + /** + * Specifies whether a grammar check has been run on the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isGrammarChecked?: boolean; + /** + * Specifies whether Word kerns half-width Latin characters and punctuation marks. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isKerningByAlgorithm?: boolean; + /** + * Specifies whether to embed speech and handwriting data. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isLinguisticDataEmbedded?: boolean; + /** + * Specifies whether Word optimizes the document for Word 97. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isOptimizedForWord97?: boolean; + /** + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isPostScriptPrintedOverText?: boolean; + /** + * Specifies whether users can change the Quick Style set. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isQuickStyleSetLocked?: boolean; + /** + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isReadOnlyRecommended?: boolean; + /** + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isSnappedToGrid?: boolean; + /** + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isSnappedToShapes?: boolean; + /** + * Specifies whether spelling has been checked throughout the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isSpellingChecked?: boolean; + /** + * Specifies whether formatting restrictions are enforced in a protected document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isStyleEnforced?: boolean; + /** + * Specifies whether users can change the document theme. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isThemeLocked?: boolean; + /** + * Specifies whether the document was created or opened by the user. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isUserControl?: boolean; + /** + * Specifies the character spacing adjustment. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + /** + * Specifies the format type that Microsoft Word uses when automatically formatting the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; + /** + * Specifies whether Microsoft Word has detected the language of the document text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageDetected?: boolean; + /** + * Specifies the kinsoku characters after which Word will not break a line. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + noLineBreakAfter?: string; + /** + * Specifies the kinsoku characters before which Word will not break a line. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + noLineBreakBefore?: string; + /** + * Sets a password that must be supplied to open the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + password?: string; + /** + * Specifies whether revision marks are printed with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + printRevisions?: boolean; + /** + * Specifies the width of pages in reading layout view when frozen. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readingLayoutSizeX?: number; + /** + * Specifies the height of pages in reading layout view when frozen. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readingLayoutSizeY?: number; + /** + * Specifies whether pages in reading layout view are frozen for handwritten markup. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readingModeIsLayoutFrozen?: boolean; + /** + * Specifies whether Word removes user information upon saving. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + removePersonalInformationOnSave?: boolean; + /** + * Specifies the encoding used when saving the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + /** + * Specifies the encoding for saving as encoded text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + /** + * Specifies how Word marks line and paragraph breaks in text files. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; + /** + * Specifies whether to track formatting changes when change tracking is on. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + trackFormatting?: boolean; + /** + * Specifies whether to mark moved text when Track Changes is on. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + trackMoves?: boolean; + /** + * Specifies whether changes are tracked in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + trackRevisions?: boolean; + /** + * Specifies whether to remove or store date and time metadata for tracked changes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + trackedChangesAreDateAndTimeRemoved?: boolean; + /** + * Sets a password for saving changes to the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + writePassword?: string; + /** + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + xmlAreAdvancedErrorsShown?: boolean; + /** + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + xmlIsXsltUsedWhenSaving?: boolean; + /** + * Specifies the path and file name for the XSLT to apply when saving a document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + xmlSaveThroughXslt?: string; + } + /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ + interface DocumentCreatedUpdateData { + /** + * Gets the `Body` object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesUpdateData; + } + /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ + interface DocumentPropertiesUpdateData { + /** + * Specifies the author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + author?: string; + /** + * Specifies the category of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + category?: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: string; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: string; + /** + * Specifies the keywords of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + keywords?: string; + /** + * Specifies the manager of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + manager?: string; + /** + * Specifies the subject of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subject?: string; + /** + * Specifies the title of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + title?: string; + } + /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ + interface FieldUpdateData { + /** + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the field's code instruction. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code?: string; + /** + * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data?: string; + /** + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked?: boolean; + /** + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + showCodes?: boolean; + } + /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ + interface FieldCollectionUpdateData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ + interface FontUpdateData { + /** + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fill?: Word.Interfaces.FillFormatUpdateData; + /** + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + glow?: Word.Interfaces.GlowFormatUpdateData; + /** + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + line?: Word.Interfaces.LineFormatUpdateData; + /** + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + reflection?: Word.Interfaces.ReflectionFormatUpdateData; + /** + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textShadow?: Word.Interfaces.ShadowFormatUpdateData; + /** + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; + /** + * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + allCaps?: boolean; + /** + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold?: boolean; + /** + * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + boldBidirectional?: boolean; + /** + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies a `ColorIndex` value that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies the color for the `Font` object in a right-to-left language document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether contextual alternates are enabled for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + contextualAlternates?: boolean; + /** + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + diacriticColor?: string; + /** + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + disableCharacterSpaceGrid?: boolean; + /** + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + /** + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + emboss?: boolean; + /** + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + /** + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + engrave?: boolean; + /** + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + hidden?: boolean; + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to `null`. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor?: string; + /** + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic?: boolean; + /** + * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + italicBidirectional?: boolean; + /** + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + kerning?: number; + /** + * Specifies the ligature setting for the `Font` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + /** + * Specifies the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + name?: string; + /** + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nameAscii?: string; + /** + * Specifies the font name in a right-to-left language document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nameBidirectional?: string; + /** + * Specifies the East Asian font name. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nameFarEast?: string; + /** + * Specifies the font used for characters with codes from 128 through 255. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nameOther?: string; + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + /** + * Specifies the number spacing setting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + /** + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + outline?: boolean; + /** + * Specifies the position of text (in points) relative to the base line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + position?: number; + /** + * Specifies the scaling percentage applied to the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + scaling?: number; + /** + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shadow?: boolean; + /** + * Specifies the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size?: number; + /** + * Specifies the font size in points for right-to-left text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sizeBidirectional?: number; + /** + * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + smallCaps?: boolean; + /** + * Specifies the spacing between characters. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spacing?: number; + /** + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies the stylistic set for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + /** + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript?: boolean; + /** + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript?: boolean; + /** + * Specifies the font's underline type. `none` if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + underlineColor?: string; + } + /** An interface for updating data on the `HeadingStyle` object, for use in `headingStyle.set({ ... })`. */ + interface HeadingStyleUpdateData { + /** + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + level?: number; + /** + * Specifies the name of style for a heading. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + name?: string; + } + /** An interface for updating data on the `HeadingStyleCollection` object, for use in `headingStyleCollection.set({ ... })`. */ + interface HeadingStyleCollectionUpdateData { + items?: Word.Interfaces.HeadingStyleData[]; + } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + interface HyperlinkUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the address (for example, a file name or URL) of the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + address?: string; + /** + * Specifies the text string for the hyperlink's subject line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + emailSubject?: string; + /** + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + screenTip?: string; + /** + * Specifies a named location in the destination of the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + subAddress?: string; + /** + * Specifies the name of the frame or window in which to load the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + target?: string; + /** + * Specifies the hyperlink's visible text in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textToDisplay?: string; + } + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + interface HyperlinkCollectionUpdateData { + items?: Word.Interfaces.HyperlinkData[]; + } + /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ + interface InlinePictureUpdateData { + /** + * Specifies a string that represents the alternative text associated with the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextDescription?: string; + /** + * Specifies a string that contains the title for the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextTitle?: string; + /** + * Specifies a number that describes the height of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + height?: number; + /** + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.1] + */ + hyperlink?: string; + /** + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lockAspectRatio?: boolean; + /** + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + width?: number; + } + /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ + interface InlinePictureCollectionUpdateData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface for updating data on the `LinkFormat` object, for use in `linkFormat.set({ ... })`. */ + interface LinkFormatUpdateData { + /** + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isAutoUpdated?: boolean; + /** + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isLocked?: boolean; + /** + * Specifies if the linked picture is saved with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isPictureSavedWithDocument?: boolean; + /** + * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sourceFullName?: string; + } + /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ + interface ListCollectionUpdateData { + items?: Word.Interfaces.ListData[]; + } + /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ + interface ListItemUpdateData { + /** + * Specifies the level of the item in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + level?: number; + } + /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ + interface ListLevelUpdateData { + /** + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the name of the style that's linked to the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + linkedStyle?: string; + /** + * Specifies the number format for the list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberFormat?: string; + /** + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberPosition?: number; + /** + * Specifies the number style for the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + /** + * Specifies the list level that must appear before it restarts numbering at 1. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + resetOnHigher?: number; + /** + * Specifies the starting number for the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + startAt?: number; + /** + * Specifies the tab position for the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + tabPosition?: number; + /** + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + textPosition?: number; + /** + * Specifies the character inserted after the number for the list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; + } + /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ + interface ListLevelCollectionUpdateData { + items?: Word.Interfaces.ListLevelData[]; + } + /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ + interface ListTemplateUpdateData { + /** + * Specifies the name of the list template. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + name?: string; + /** + * Specifies whether the list template is outline numbered. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outlineNumbered?: boolean; + } + /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ + interface NoteItemUpdateData { + /** + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + reference?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ + interface NoteItemCollectionUpdateData { + items?: Word.Interfaces.NoteItemData[]; + } + /** An interface for updating data on the `OleFormat` object, for use in `oleFormat.set({ ... })`. */ + interface OleFormatUpdateData { + /** + * Specifies the class type for the specified OLE object, picture, or field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + classType?: string; + /** + * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + iconIndex?: number; + /** + * Specifies the text displayed below the icon for the OLE object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + iconLabel?: string; + /** + * Specifies the program file in which the icon for the OLE object is stored. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + iconName?: string; + /** + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFormattingPreservedOnUpdate?: boolean; + } + /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ + interface PageCollectionUpdateData { + items?: Word.Interfaces.PageData[]; + } + /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ + interface PaneCollectionUpdateData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */ + interface WindowUpdateData { + /** + * Gets the next document window in the collection of open document windows. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + next?: Word.Interfaces.WindowUpdateData; + /** + * Gets the previous document window in the collection open document windows. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + previous?: Word.Interfaces.WindowUpdateData; + /** + * Specifies whether rulers are displayed for the window or pane. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areRulersDisplayed?: boolean; + /** + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areThumbnailsDisplayed?: boolean; + /** + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + caption?: string; + /** + * Specifies the horizontal scroll position as a percentage of the document width. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + horizontalPercentScrolled?: number; + /** + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + /** + * Specifies whether the document map is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isDocumentMapVisible?: boolean; + /** + * Specifies whether the email message header is visible in the document window. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isEnvelopeVisible?: boolean; + /** + * Specifies whether a horizontal scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isHorizontalScrollBarDisplayed?: boolean; + /** + * Specifies whether the vertical scroll bar appears on the left side of the document window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isLeftScrollBarDisplayed?: boolean; + /** + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isRightRulerDisplayed?: boolean; + /** + * Specifies whether the window is split into multiple panes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isSplit?: boolean; + /** + * Specifies whether a vertical ruler is displayed for the window or pane. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isVerticalRulerDisplayed?: boolean; + /** + * Specifies whether a vertical scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isVerticalScrollBarDisplayed?: boolean; + /** + * Specifies whether the window is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isVisible?: boolean; + /** + * Specifies how Microsoft Word displays source documents after a compare and merge process. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + /** + * Specifies the vertical split percentage for the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + splitVertical?: number; + /** + * Specifies the width of the style area in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + styleAreaWidth?: number; + /** + * Specifies the vertical scroll position as a percentage of the document length. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + verticalPercentScrolled?: number; + } + /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ + interface WindowCollectionUpdateData { + items?: Word.Interfaces.WindowData[]; + } + /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ + interface ParagraphUpdateData { + /** + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listItem?: Word.Interfaces.ListItemUpdateData; + /** + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent?: number; + /** + * Specifies the left indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + leftIndent?: number; + /** + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineSpacing?: number; + /** + * Specifies the amount of spacing, in grid lines, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitAfter?: number; + /** + * Specifies the amount of spacing, in grid lines, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitBefore?: number; + /** + * Specifies the outline level for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + outlineLevel?: number; + /** + * Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + rightIndent?: number; + /** + * Specifies the spacing, in points, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceAfter?: number; + /** + * Specifies the spacing, in points, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceBefore?: number; + /** + * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ + interface ParagraphCollectionUpdateData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ + interface ParagraphFormatUpdateData { + /** + * Specifies the alignment for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + firstLineIndent?: number; + /** + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepTogether?: boolean; + /** + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepWithNext?: boolean; + /** + * Specifies the left indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + leftIndent?: number; + /** + * Specifies the line spacing (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineSpacing?: number; + /** + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitAfter?: number; + /** + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitBefore?: number; + /** + * Specifies whether left and right indents are the same width. + * + * @remarks + * [Api set: WordApi 1.5] + */ + mirrorIndents?: boolean; + /** + * Specifies the outline level for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + /** + * Specifies the right indent (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + rightIndent?: number; + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceAfter?: number; + /** + * Specifies the spacing (in points) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceBefore?: number; + /** + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + widowControl?: boolean; + } + /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ + interface RangeUpdateData { + /** + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listFormat?: Word.Interfaces.ListFormatUpdateData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies a `CharacterCase` value that represents the case of the text in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + /** + * Specifies the character width of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + characterWidth?: Word.CharacterWidth | "Half" | "Full"; + /** + * Specifies if the range contains combined characters. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + combineCharacters?: boolean; + /** + * Specifies the ending character position of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + end?: number; + /** + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fitTextWidth?: number; + /** + * Specifies if a grammar check has been run on the range or document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + grammarChecked?: boolean; + /** + * Specifies the proofing status (spelling and grammar checking) of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hasNoProofing?: boolean; + /** + * Specifies the formatting for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; + /** + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.3] + */ + hyperlink?: string; + /** + * Specifies the ID for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + id?: string; + /** + * Specifies whether the range of Japanese language text is hiragana or katakana. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + kana?: Word.Kana | "Katakana" | "Hiragana"; + /** + * Specifies whether Microsoft Word has detected the language of the text in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageDetected?: boolean; + /** + * Specifies a `LanguageId` value that represents the language for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies an East Asian language for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies a language for the range that isn't classified as an East Asian language. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + showAll?: boolean; + /** + * Specifies if spelling has been checked throughout the range or document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + spellingChecked?: boolean; + /** + * Specifies the starting character position of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + start?: number; + /** + * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + } + /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ + interface RangeCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ + interface SearchOptionsUpdateData { + /** + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignorePunct?: boolean; + /** + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignoreSpace?: boolean; + /** + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchCase?: boolean; + /** + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchPrefix?: boolean; + /** + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchSuffix?: boolean; + /** + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWholeWord?: boolean; + /** + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWildcards?: boolean; + } + /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ + interface SectionUpdateData { + /** + * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** + * Specifies if the section is protected for forms. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + protectedForForms?: boolean; + } + /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ + interface SectionCollectionUpdateData { + items?: Word.Interfaces.SectionData[]; + } + /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ + interface SettingUpdateData { + /** + * Specifies the value of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + value?: any; + } + /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ + interface SettingCollectionUpdateData { + items?: Word.Interfaces.SettingData[]; + } + /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ + interface StyleCollectionUpdateData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ + interface StyleUpdateData { + /** + * Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + borders?: Word.Interfaces.BorderCollectionUpdateData; + /** + * Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frame?: Word.Interfaces.FrameUpdateData; + /** + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + linkStyle?: Word.Interfaces.StyleUpdateData; + /** + * Gets a `ListTemplate` object that represents the list formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + listTemplate?: Word.Interfaces.ListTemplateUpdateData; + /** + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; + /** + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * + * @remarks + * [Api set: WordApi 1.6] + */ + shading?: Word.Interfaces.ShadingUpdateData; + /** + * Gets a `TableStyle` object representing style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ + tableStyle?: Word.Interfaces.TableStyleUpdateData; + /** + * Specifies whether the style is automatically redefined based on the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + automaticallyUpdate?: boolean; + /** + * Specifies the name of an existing style to use as the base formatting of another style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + */ + baseStyle?: string; + /** + * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hasProofing?: boolean; + /** + * Specifies a `LanguageId` value that represents the language for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies an East Asian language for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies whether the style cannot be changed or edited. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + locked?: boolean; + /** + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + */ + nextParagraphStyle?: string; + /** + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + noSpaceBetweenParagraphsOfSameStyle?: boolean; + /** + * Specifies the priority. + * + * @remarks + * [Api set: WordApi 1.5] + */ + priority?: number; + /** + * Specifies whether the style corresponds to an available quick style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + quickStyle?: boolean; + /** + * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + unhideWhenUsed?: boolean; + /** + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * + * @remarks + * [Api set: WordApi 1.5] + */ + visibility?: boolean; + } + /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ + interface ShadingUpdateData { + /** + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.6] + */ + backgroundPatternColor?: string; + /** + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + foregroundPatternColor?: string; + /** + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ + interface ShadingUniversalUpdateData { + /** + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + backgroundPatternColor?: string; + /** + * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + foregroundPatternColor?: string; + /** + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ + interface TableUpdateData { + /** + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the description of the table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + description?: string; + /** + * Specifies the number of header rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + headerRowCount?: number; + /** + * Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: string; + /** + * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + style?: string; + /** + * Specifies whether the table has banded columns. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedColumns?: boolean; + /** + * Specifies whether the table has banded rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedRows?: boolean; + /** + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies whether the table has a first column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleFirstColumn?: boolean; + /** + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleLastColumn?: boolean; + /** + * Specifies whether the table has a total (last) row with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleTotalRow?: boolean; + /** + * Specifies the title of the table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + title?: string; + /** + * Specifies the text values in the table, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: string[][]; + /** + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + /** + * Specifies the width of the table in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: number; + } + /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ + interface TableStyleUpdateData { + /** + * Specifies the table's alignment against the page margin. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies whether lines in tables formatted with a style break across pages. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + allowBreakAcrossPage?: boolean; + /** + * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + bottomCellMargin?: number; + /** + * Specifies the spacing (in points) between the cells in a table style. + * + * @remarks + * [Api set: WordApi 1.6] + */ + cellSpacing?: number; + /** + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + columnStripe?: number; + /** + * Specifies whether Microsoft Word allows to break the specified table across pages. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isBreakAcrossPagesAllowed?: boolean; + /** + * Specifies the amount of space to add between the contents and the left borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + leftCellMargin?: number; + /** + * Specifies the left indent value (in points) for the rows in the table style. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + leftIndent?: number; + /** + * Specifies the amount of space to add between the contents and the right borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + rightCellMargin?: number; + /** + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + rowStripe?: number; + /** + * Specifies the direction in which Microsoft Word orders cells in the table style. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; + /** + * Specifies the amount of space to add between the contents and the top borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + topCellMargin?: number; + } + /** An interface for updating data on the `TabStopCollection` object, for use in `tabStopCollection.set({ ... })`. */ + interface TabStopCollectionUpdateData { + items?: Word.Interfaces.TabStopData[]; + } + /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ + interface TableCollectionUpdateData { + items?: Word.Interfaces.TableData[]; + } + /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ + interface TableColumnUpdateData { + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + preferredWidth?: number; + /** + * Specifies the preferred unit of measurement to use for the width of the table column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + /** + * Specifies the width of the column, in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + width?: number; + } + /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ + interface TableColumnCollectionUpdateData { + items?: Word.Interfaces.TableColumnData[]; + } + /** An interface for updating data on the `TableOfAuthorities` object, for use in `tableOfAuthorities.set({ ... })`. */ + interface TableOfAuthoritiesUpdateData { + /** + * Specifies the name of the bookmark from which to collect table of authorities entries. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bookmark?: string; + /** + * 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + category?: number; + /** + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + entrySeparator?: string; + /** + * Specifies whether the category name for a group of entries appears in the table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isCategoryHeaderIncluded?: boolean; + /** + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isEntryFormattingKept?: boolean; + /** + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isPassimUsed?: boolean; + /** + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pageNumberSeparator?: string; + /** + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pageRangeSeparator?: string; + /** + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sequenceName?: string; + /** + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sequenceSeparator?: string; + /** + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface for updating data on the `TableOfAuthoritiesCollection` object, for use in `tableOfAuthoritiesCollection.set({ ... })`. */ + interface TableOfAuthoritiesCollectionUpdateData { + items?: Word.Interfaces.TableOfAuthoritiesData[]; + } + /** An interface for updating data on the `TableOfAuthoritiesCategoryCollection` object, for use in `tableOfAuthoritiesCategoryCollection.set({ ... })`. */ + interface TableOfAuthoritiesCategoryCollectionUpdateData { + items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; + } + /** An interface for updating data on the `TableOfContents` object, for use in `tableOfContents.set({ ... })`. */ + interface TableOfContentsUpdateData { + /** + * Specifies whether built-in heading styles are used for the table of contents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areBuiltInHeadingStylesUsed?: boolean; + /** + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areFieldsUsed?: boolean; + /** + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areHyperlinksUsedOnWeb?: boolean; + /** + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + arePageNumbersHiddenOnWeb?: boolean; + /** + * Specifies whether page numbers are included in the table of contents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + arePageNumbersIncluded?: boolean; + /** + * Specifies whether page numbers are aligned with the right margin in the table of contents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + arePageNumbersRightAligned?: boolean; + /** + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + lowerHeadingLevel?: number; + /** + * Specifies the character between entries and their page numbers in the table of contents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + /** + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tableId?: string; + /** + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + upperHeadingLevel?: number; + } + /** An interface for updating data on the `TableOfContentsCollection` object, for use in `tableOfContentsCollection.set({ ... })`. */ + interface TableOfContentsCollectionUpdateData { + items?: Word.Interfaces.TableOfContentsData[]; + } + /** An interface for updating data on the `TableOfFigures` object, for use in `tableOfFigures.set({ ... })`. */ + interface TableOfFiguresUpdateData { + /** + * Specifies whether built-in heading styles are used for the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areBuiltInHeadingStylesUsed?: boolean; + /** + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areFieldsUsed?: boolean; + /** + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areHyperlinksUsedOnWeb?: boolean; + /** + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + arePageNumbersHiddenOnWeb?: boolean; + /** + * Specifies whether page numbers are included in the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + arePageNumbersIncluded?: boolean; + /** + * Specifies whether page numbers are aligned with the right margin in the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + arePageNumbersRightAligned?: boolean; + /** + * Specifies the label that identifies the items to be included in the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + captionLabel?: string; + /** + * Specifies whether the caption label and caption number are included in the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isLabelIncluded?: boolean; + /** + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + lowerHeadingLevel?: number; + /** + * Specifies the character between entries and their page numbers in the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + /** + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tableId?: string; + /** + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + upperHeadingLevel?: number; + } + /** An interface for updating data on the `TableOfFiguresCollection` object, for use in `tableOfFiguresCollection.set({ ... })`. */ + interface TableOfFiguresCollectionUpdateData { + items?: Word.Interfaces.TableOfFiguresData[]; + } + /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ + interface TableRowUpdateData { + /** + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the preferred height of the row in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + preferredHeight?: number; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: string; + /** + * Specifies the text values in the row, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: string[][]; + /** + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ + interface TableRowCollectionUpdateData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ + interface TableCellUpdateData { + /** + * Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + */ + columnWidth?: number; + /** + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: string; + /** + * Specifies the text of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: string; + /** + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ + interface TableCellCollectionUpdateData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ + interface TableBorderUpdateData { + /** + * Specifies the table border color. + * + * @remarks + * [Api set: WordApi 1.3] + */ + color?: string; + /** + * Specifies the type of the table border. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: number; + } + /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ + interface TemplateUpdateData { + /** + * Specifies the East Asian language to use when breaking lines of text in the document or template. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + /** + * Specifies the line break control level for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + /** + * Specifies whether the spelling and grammar checker ignores documents based on this template. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hasNoProofing?: boolean; + /** + * Specifies the character spacing adjustment for the template. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + /** + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + kerningByAlgorithm?: boolean; + /** + * Specifies a `LanguageId` value that represents the language in the template. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies an East Asian language for the language in the template. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + noLineBreakAfter?: string; + /** + * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + noLineBreakBefore?: string; + /** + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + saved?: boolean; + } + /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ + interface TemplateCollectionUpdateData { + items?: Word.Interfaces.TemplateData[]; + } + /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ + interface TrackedChangeCollectionUpdateData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface for updating data on the `View` object, for use in `view.set({ ... })`. */ + interface ViewUpdateData { + /** + * Specifies whether all nonprinting characters are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areAllNonprintingCharactersDisplayed?: boolean; + /** + * Gets whether background colors and images are shown when the document is displayed in print layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areBackgroundsDisplayed?: boolean; + /** + * Specifies whether Microsoft Word displays the comments in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areCommentsDisplayed?: boolean; + /** + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; + /** + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areEditableRangesShaded?: boolean; + /** + * Specifies whether field codes are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areFieldCodesDisplayed?: boolean; + /** + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areFormatChangesDisplayed?: boolean; + /** + * Specifies whether handwritten ink annotations are shown or hidden. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areInkAnnotationsDisplayed?: boolean; + /** + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areInsertionsAndDeletionsDisplayed?: boolean; + /** + * Gets whether other authors' presence should be visible in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areOtherAuthorsVisible?: boolean; + /** + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areRevisionsAndCommentsDisplayed?: boolean; + /** + * Specifies whether table gridlines are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areTableGridlinesDisplayed?: boolean; + /** + * Specifies the column width in Reading mode. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + /** + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isDraft?: boolean; + /** + * Specifies whether only the first line of body text is shown in outline view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFirstLineOnlyDisplayed?: boolean; + /** + * Specifies whether character formatting is visible in outline view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFormatDisplayed?: boolean; + /** + * Specifies whether the window is in full-screen view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFullScreen?: boolean; + /** + * Specifies whether the document is in conflict mode view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isInConflictMode?: boolean; + /** + * Specifies whether Microsoft Word is in Panning mode. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isInPanning?: boolean; + /** + * Specifies whether the document is being viewed in reading layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isInReadingLayout?: boolean; + /** + * Specifies whether mail merge data is displayed instead of mail merge fields. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isMailMergeDataView?: boolean; + /** + * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isMainTextLayerVisible?: boolean; + /** + * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isPointerShownAsMagnifier?: boolean; + /** + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isReadingLayoutActualView?: boolean; + /** + * Specifies whether XML tags are visible in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isXmlMarkupVisible?: boolean; + /** + * Specifies the display mode for tracked changes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + /** + * Specifies the page color in Reading mode. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; + /** + * Specifies the page movement type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; + /** + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + /** + * Specifies the width of the revision balloons. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + revisionsBalloonWidth?: number; + /** + * Specifies how Microsoft Word measures the width of revision balloons. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + /** + * Specifies the document element displayed in print layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + /** + * Specifies the active window pane. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + /** + * Specifies the view type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + } + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + interface ShapeUpdateData { + /** + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + canvas?: Word.Interfaces.CanvasUpdateData; + /** + * Returns the fill formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + fill?: Word.Interfaces.ShapeFillUpdateData; + /** + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + parentCanvas?: Word.Interfaces.ShapeUpdateData; + /** + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + parentGroup?: Word.Interfaces.ShapeUpdateData; + /** + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; + /** + * Gets the `TextFrame` object of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + textFrame?: Word.Interfaces.TextFrameUpdateData; + /** + * Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; + /** + * Specifies whether a given shape can overlap other shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + allowOverlap?: boolean; + /** + * Specifies a string that represents the alternative text associated with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + altTextDescription?: string; + /** + * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + /** + * The height, in points, of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + height?: number; + /** + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + heightRelative?: number; + /** + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + left?: number; + /** + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + leftRelative?: number; + /** + * Specifies if the aspect ratio of this shape is locked. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + lockAspectRatio?: boolean; + /** + * The name of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + name?: string; + /** + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + rotation?: number; + /** + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + top?: number; + /** + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topRelative?: number; + /** + * Specifies if the shape is visible. Not applicable to inline shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + visible?: boolean; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + width?: number; + /** + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + widthRelative?: number; + } + /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ + interface ShapeGroupUpdateData { + /** + * Gets the `Shape` object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shape?: Word.Interfaces.ShapeUpdateData; + } + /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ + interface CanvasUpdateData { + /** + * Gets the `Shape` object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shape?: Word.Interfaces.ShapeUpdateData; + } + /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ + interface ShapeCollectionUpdateData { + items?: Word.Interfaces.ShapeData[]; + } + /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ + interface ShapeFillUpdateData { + /** + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + backgroundColor?: string; + /** + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + foregroundColor?: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + transparency?: number; + } + /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ + interface TextFrameUpdateData { + /** + * Specifies the automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + /** + * Specifies the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + bottomMargin?: number; + /** + * Specifies the left margin, in points, of the text frame. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + leftMargin?: number; + /** + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + noTextRotation?: boolean; + /** + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + /** + * Specifies the right margin, in points, of the text frame. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + rightMargin?: number; + /** + * Specifies the top margin, in points, of the text frame. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topMargin?: number; + /** + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + /** + * Determines whether lines break automatically to fit text inside the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + wordWrap?: boolean; + } + /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ + interface ShapeTextWrapUpdateData { + /** + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + bottomDistance?: number; + /** + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + leftDistance?: number; + /** + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + rightDistance?: number; + /** + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + /** + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topDistance?: number; + /** + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + } + /** An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`. */ + interface ReviewerUpdateData { + /** + * Specifies if the `Reviewer` object is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isVisible?: boolean; + } + /** An interface for updating data on the `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`. */ + interface ReviewerCollectionUpdateData { + items?: Word.Interfaces.ReviewerData[]; + } + /** An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`. */ + interface RevisionsFilterUpdateData { + /** + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; + /** + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ + interface RepeatingSectionItemUpdateData { + /** + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `Revision` object, for use in `revision.set({ ... })`. */ + interface RevisionUpdateData { + /** + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + movedRange?: Word.Interfaces.RangeUpdateData; + /** + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `RevisionCollection` object, for use in `revisionCollection.set({ ... })`. */ + interface RevisionCollectionUpdateData { + items?: Word.Interfaces.RevisionData[]; + } + /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ + interface DatePickerContentControlUpdateData { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + color?: string; + /** + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + /** + * Specifies the format in which dates are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dateDisplayFormat?: string; + /** + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isTemporary?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockContents?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tag?: string; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + title?: string; + } + /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ + interface PictureContentControlUpdateData { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + /** + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + color?: string; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isTemporary?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockContents?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tag?: string; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + title?: string; + } + /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ + interface GroupContentControlUpdateData { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + color?: string; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isTemporary?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockContents?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tag?: string; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + title?: string; + } + /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ + interface BuildingBlockGalleryContentControlUpdateData { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + /** + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies the category for the building block content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + buildingBlockCategory?: string; + /** + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + color?: string; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isTemporary?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockContents?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tag?: string; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + title?: string; + } + /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ + interface RepeatingSectionContentControlUpdateData { + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + allowInsertDeleteSection?: boolean; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + color?: string; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isTemporary?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockContents?: boolean; + /** + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + repeatingSectionItemTitle?: string; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tag?: string; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + title?: string; + } + /** An interface for updating data on the `ReadabilityStatisticCollection` object, for use in `readabilityStatisticCollection.set({ ... })`. */ + interface ReadabilityStatisticCollectionUpdateData { + items?: Word.Interfaces.ReadabilityStatisticData[]; + } + /** An interface for updating data on the `WebSettings` object, for use in `webSettings.set({ ... })`. */ + interface WebSettingsUpdateData { + /** + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + allowPng?: boolean; + /** + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + encoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + /** + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + organizeInFolder?: boolean; + /** + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pixelsPerInch?: number; + /** + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + relyOnCSS?: boolean; + /** + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + relyOnVectorMarkupLanguage?: boolean; + /** + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + screenSize?: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; + /** + * Specifies the target browser for documents viewed in a web browser. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + targetBrowser?: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; + /** + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + useLongFileNames?: boolean; + } + /** An interface for updating data on the `XmlNodeCollection` object, for use in `xmlNodeCollection.set({ ... })`. */ + interface XmlNodeCollectionUpdateData { + items?: Word.Interfaces.XmlNodeData[]; + } + /** An interface for updating data on the `XmlNode` object, for use in `xmlNode.set({ ... })`. */ + interface XmlNodeUpdateData { + /** + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + placeholderText?: string; + /** + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + text?: string; + } + /** An interface for updating data on the `HtmlDivision` object, for use in `htmlDivision.set({ ... })`. */ + interface HtmlDivisionUpdateData { + /** + * Specifies the left indent value (in points) for this HTML division. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + leftIndent?: number; + /** + * Specifies the right indent (in points) for this HTML division. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + rightIndent?: number; + /** + * Specifies the amount of spacing (in points) after this HTML division. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + spaceAfter?: number; + /** + * Specifies the spacing (in points) before this HTML division. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + spaceBefore?: number; + } + /** An interface for updating data on the `HtmlDivisionCollection` object, for use in `htmlDivisionCollection.set({ ... })`. */ + interface HtmlDivisionCollectionUpdateData { + items?: Word.Interfaces.HtmlDivisionData[]; + } + /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ + interface FrameUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies the height (in points) of the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + height?: number; + /** + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + /** + * Specifies the horizontal distance between the frame and the surrounding text, in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + horizontalDistanceFromText?: number; + /** + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + horizontalPosition?: number; + /** + * Specifies if the frame is locked. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lockAnchor?: boolean; + /** + * Specifies the relative horizontal position of the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + /** + * Specifies the relative vertical position of the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + /** + * Specifies if document text wraps around the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textWrap?: boolean; + /** + * Specifies the vertical distance (in points) between the frame and the surrounding text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + verticalDistanceFromText?: number; + /** + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + verticalPosition?: number; + /** + * Specifies the width (in points) of the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + width?: number; + /** + * Specifies the rule used to determine the width of the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + } + /** An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`. */ + interface FrameCollectionUpdateData { + items?: Word.Interfaces.FrameData[]; + } + /** An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`. */ + interface DocumentLibraryVersionCollectionUpdateData { + items?: Word.Interfaces.DocumentLibraryVersionData[]; + } + /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ + interface ListFormatUpdateData { + /** + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listTemplate?: Word.Interfaces.ListTemplateUpdateData; + /** + * Specifies the list level number for the first paragraph for the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listLevelNumber?: number; + } + /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ + interface FillFormatUpdateData { + /** + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gradientAngle?: number; + /** + * Specifies if the object, or the formatting applied to it, is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isVisible?: boolean; + /** + * Specifies whether the fill rotates with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rotateWithObject?: boolean; + /** + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + /** + * Specifies the horizontal scaling factor for the texture fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureHorizontalScale?: number; + /** + * Specifies the horizontal offset of the texture from the origin in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureOffsetX?: number; + /** + * Specifies the vertical offset of the texture. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureOffsetY?: number; + /** + * Specifies whether the texture is tiled. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureTile?: boolean; + /** + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textureVerticalScale?: number; + /** + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency?: number; + } + /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ + interface GlowFormatUpdateData { + /** + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + color?: Word.Interfaces.ColorFormatUpdateData; + /** + * Specifies the length of the radius for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + radius?: number; + /** + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency?: number; + } + /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ + interface LineFormatUpdateData { + /** + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Specifies the length of the arrowhead at the beginning of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + /** + * Specifies the style of the arrowhead at the beginning of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + /** + * Specifies the width of the arrowhead at the beginning of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + /** + * Specifies the dash style for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + /** + * Specifies the length of the arrowhead at the end of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + /** + * Specifies the style of the arrowhead at the end of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + /** + * Specifies the width of the arrowhead at the end of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + /** + * Specifies if to draw lines inside a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + insetPen?: boolean; + /** + * Specifies if the object, or the formatting applied to it, is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isVisible?: boolean; + /** + * Specifies the pattern applied to the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + /** + * Specifies the line format style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + /** + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency?: number; + /** + * Specifies the thickness of the line in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + weight?: number; + } + /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ + interface ReflectionFormatUpdateData { + /** + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + blur?: number; + /** + * Specifies the amount of separation, in points, of the reflected image from the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + offset?: number; + /** + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + size?: number; + /** + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency?: number; + /** + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + } + /** An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ + interface ColorFormatUpdateData { + /** + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + brightness?: number; + /** + * Specifies the theme color for a color format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + /** + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rgb?: string; + /** + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tintAndShade?: number; + } + /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ + interface ShadowFormatUpdateData { + /** + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + blur?: number; + /** + * Specifies whether the object or the formatting applied to it is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isVisible?: boolean; + /** + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + obscured?: boolean; + /** + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + offsetX?: number; + /** + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + offsetY?: number; + /** + * Specifies whether to rotate the shadow when rotating the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rotateWithShape?: boolean; + /** + * Specifies the width of the shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + size?: number; + /** + * Specifies the type of shadow formatting to apply to a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + /** + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency?: number; + /** + * Specifies the shape shadow type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + } + /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ + interface ThreeDimensionalFormatUpdateData { + /** + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + contourColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + extrusionColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Specifies the depth of the bottom bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelBottomDepth?: number; + /** + * Specifies the inset size for the bottom bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelBottomInset?: number; + /** + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + /** + * Specifies the depth of the top bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelTopDepth?: number; + /** + * Specifies the inset size for the top bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelTopInset?: number; + /** + * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + /** + * Specifies the width of the contour of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + contourWidth?: number; + /** + * Specifies the depth of the shape's extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + depth?: number; + /** + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + /** + * Specifies the amount of perspective for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fieldOfView?: number; + /** + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isPerspective?: boolean; + /** + * Specifies if the specified object, or the formatting applied to it, is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isVisible?: boolean; + /** + * Specifies the angle of the lighting. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lightAngle?: number; + /** + * Specifies a `LightRigType` value that represents the lighting preset. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + /** + * Specifies the position of the light source relative to the extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + /** + * Specifies the intensity of the extrusion lighting. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + /** + * Specifies the extrusion surface material. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + /** + * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + projectText?: boolean; + /** + * Specifies the rotation of the extruded shape around the x-axis in degrees. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rotationX?: number; + /** + * Specifies the rotation of the extruded shape around the y-axis in degrees. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rotationY?: number; + /** + * Specifies the z-axis rotation of the camera. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rotationZ?: number; + /** + * Specifies the position on the z-axis for the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + z?: number; + } + /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ + interface BibliographyUpdateData { + /** + * Specifies the name of the active style to use for the bibliography. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bibliographyStyle?: string; + } + /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ + interface SourceCollectionUpdateData { + items?: Word.Interfaces.SourceData[]; + } + /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ + interface PageSetupUpdateData { + /** + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lineNumbering?: Word.Interfaces.LineNumberingUpdateData; + /** + * Specifies whether Microsoft Word prints the document as a booklet. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bookFoldPrinting?: boolean; + /** + * Specifies the number of pages for each booklet. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bookFoldPrintingSheets?: number; + /** + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bookFoldReversePrinting?: boolean; + /** + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bottomMargin?: number; + /** + * Specifies the number of characters per line in the document grid. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + charsLine?: number; + /** + * Specifies whether the first page has a different header and footer. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + differentFirstPageHeaderFooter?: boolean; + /** + * Specifies the distance between the footer and the bottom of the page in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + footerDistance?: number; + /** + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gutter?: number; + /** + * Specifies on which side the gutter appears in a document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + /** + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + /** + * Specifies the distance between the header and the top of the page in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + headerDistance?: number; + /** + * Specifies the layout mode for the current document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + /** + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + leftMargin?: number; + /** + * Specifies the number of lines per page in the document grid. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + linesPage?: number; + /** + * Specifies if the inside and outside margins of facing pages are the same width. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + mirrorMargins?: boolean; + /** + * Specifies whether odd and even pages have different headers and footers. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + oddAndEvenPagesHeaderFooter?: boolean; + /** + * Specifies the orientation of the page. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + /** + * Specifies the page height in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageHeight?: number; + /** + * Specifies the page width in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageWidth?: number; + /** + * Specifies the paper size of the page. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + /** + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + rightMargin?: number; + /** + * Specifies the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + /** + * Specifies the type of section break for the specified object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + /** + * Specifies whether to show the grid. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + showGrid?: boolean; + /** + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + suppressEndnotes?: boolean; + /** + * Specifies the top margin of the page in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + topMargin?: number; + /** + * Specifies whether to print two pages per sheet. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + twoPagesOnOne?: boolean; + /** + * Specifies the vertical alignment of text on each page in a document or section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + } + /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ + interface LineNumberingUpdateData { + /** + * Specifies the numeric increment for line numbers. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + countBy?: number; + /** + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + distanceFromText?: number; + /** + * Specifies if line numbering is active for the specified document, section, or sections. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isActive?: boolean; + /** + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + /** + * Specifies the starting line number. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + startingNumber?: number; + } + /** An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`. */ + interface TextColumnCollectionUpdateData { + items?: Word.Interfaces.TextColumnData[]; + } + /** An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`. */ + interface TextColumnUpdateData { + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spaceAfter?: number; + /** + * Specifies the width, in points, of the specified text columns. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + width?: number; + } + /** An interface for updating data on the `Selection` object, for use in `selection.set({ ... })`. */ + interface SelectionUpdateData { + /** + * Specifies the ending character position of the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + end?: number; + /** + * Specifies the width in which Word fits the text in the current selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fitTextWidth?: number; + /** + * Specifies whether column selection mode is active. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isColumnSelectModeActive?: boolean; + /** + * Specifies whether Extend mode is active. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isExtendModeActive?: boolean; + /** + * Specifies whether the beginning of the selection is active. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isStartActive?: boolean; + /** + * Specifies whether Word has detected the language of the selected text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + languageDetected?: boolean; + /** + * Specifies the orientation of text in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + /** + * Specifies the starting character position of the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + start?: number; + /** + * Specifies the text in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + text?: string; + } + /** An interface for updating data on the `RangeScopedCollection` object, for use in `rangeScopedCollection.set({ ... })`. */ + interface RangeScopedCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ + interface BookmarkUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the ending character position of the bookmark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + end?: number; + /** + * Specifies the starting character position of the bookmark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + start?: number; + } + /** An interface for updating data on the `BookmarkCollection` object, for use in `bookmarkCollection.set({ ... })`. */ + interface BookmarkCollectionUpdateData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface for updating data on the `Index` object, for use in `index.set({ ... })`. */ + interface IndexUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that is contained within the index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the leader character between entries in the index and their associated page numbers. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface for updating data on the `IndexCollection` object, for use in `indexCollection.set({ ... })`. */ + interface IndexCollectionUpdateData { + items?: Word.Interfaces.IndexData[]; + } + /** An interface for updating data on the `ListTemplateCollection` object, for use in `listTemplateCollection.set({ ... })`. */ + interface ListTemplateCollectionUpdateData { + items?: Word.Interfaces.ListTemplateData[]; + } + /** An interface for updating data on the `ListTemplateGalleryCollection` object, for use in `listTemplateGalleryCollection.set({ ... })`. */ + interface ListTemplateGalleryCollectionUpdateData { + items?: Word.Interfaces.ListTemplateGalleryData[]; + } + /** An interface describing the data returned by calling `editor.toJSON()`. */ + interface EditorData { + /** + * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + nextRange?: Word.Interfaces.RangeData; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeData; + /** + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + id?: string; + /** + * Gets the name of the editor. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + name?: string; + } + /** An interface describing the data returned by calling `conflictCollection.toJSON()`. */ + interface ConflictCollectionData { + items?: Word.Interfaces.ConflictData[]; + } + /** An interface describing the data returned by calling `conflict.toJSON()`. */ + interface ConflictData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeData; + /** + * Gets the `RevisionType` for the `Conflict` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + } + /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ + interface CritiqueAnnotationData { + /** + * Gets the critique that was passed when the annotation was inserted. + * + * @remarks + * [Api set: WordApi 1.7] + */ + critique?: Word.Critique; + } + /** An interface describing the data returned by calling `annotation.toJSON()`. */ + interface AnnotationData { + /** + * Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + id?: string; + /** + * Gets the state of the annotation. + * + * @remarks + * [Api set: WordApi 1.7] + */ + state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; + } + /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ + interface AnnotationCollectionData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface describing the data returned by calling `application.toJSON()`. */ + interface ApplicationData { + /** + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bibliography?: Word.Interfaces.BibliographyData; + /** + * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + listTemplateGalleries?: Word.Interfaces.ListTemplateGalleryData[]; + /** + * Specifies if Microsoft Word automatically detects the language you are using as you type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + checkLanguage?: boolean; + /** + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + language?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + } + /** An interface describing the data returned by calling `body.toJSON()`. */ + interface BodyData { + /** + * Gets the collection of rich text content control objects in the body. + * + * @remarks + * [Api set: WordApi 1.1] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * Gets the collection of `Field` objects in the body. + * + * @remarks + * [Api set: WordApi 1.4] + */ + fields?: Word.Interfaces.FieldData[]; + /** + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontData; + /** + * Gets the collection of `InlinePicture` objects in the body. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ + inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** + * Gets the collection of `List` objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lists?: Word.Interfaces.ListData[]; + /** + * Gets the collection of `Paragraph` objects in the body. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * Gets the collection of `Shape` objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + */ + shapes?: Word.Interfaces.ShapeData[]; + /** + * Gets the collection of `Table` objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + tables?: Word.Interfaces.TableData[]; + /** + * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the text of the body. Use the insertText method to insert text. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: string; + /** + * Gets the type of the body. The type can be `mainDoc`, `section`, `header`, `footer`, or `tableCell`. Additional types `footnote`, `endnote`, and `noteItem` are supported in WordApi 1.5 and later. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem"; + } + /** An interface describing the data returned by calling `border.toJSON()`. */ + interface BorderData { + /** + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + color?: string; + /** + * Gets the location of the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; + /** + * Specifies the border type for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + visible?: boolean; + /** + * Specifies the width for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + } + /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ + interface BorderUniversalData { + /** + * Specifies the graphical page-border design for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + /** + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + artWidth?: number; + /** + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + color?: string; + /** + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Returns `true` if an inside border can be applied to the specified object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + inside?: boolean; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isVisible?: boolean; + /** + * Specifies the line style of the border. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + /** + * Specifies the line width of an object's border. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + } + /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ + interface BorderCollectionData { + items?: Word.Interfaces.BorderData[]; + } + /** An interface describing the data returned by calling `borderUniversalCollection.toJSON()`. */ + interface BorderUniversalCollectionData { + items?: Word.Interfaces.BorderUniversalData[]; + } + /** An interface describing the data returned by calling `break.toJSON()`. */ + interface BreakData { + /** + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeData; + /** + * Returns the page number on which the break occurs. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageIndex?: number; + } + /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ + interface BreakCollectionData { + items?: Word.Interfaces.BreakData[]; + } + /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ + interface BuildingBlockData { + /** + * Specifies the description for the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + description?: string; + /** + * Returns the internal identification number for the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + id?: string; + /** + * Returns the position of this building block in a collection. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + index?: number; + /** + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + /** + * Specifies the name of the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + name?: string; + /** + * Specifies the contents of the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + value?: string; + } + /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ + interface BuildingBlockCategoryData { + /** + * Returns the position of the `BuildingBlockCategory` object in a collection. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + index?: number; + /** + * Returns the name of the `BuildingBlockCategory` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + name?: string; + } + /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ + interface BuildingBlockTypeItemData { + /** + * Returns the position of an item in a collection. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + index?: number; + /** + * Returns the localized name of a building block type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + name?: string; + } + /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ + interface CheckboxContentControlData { + /** + * Specifies the current state of the checkbox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + isChecked?: boolean; + } + /** An interface describing the data returned by calling `coauthoringLock.toJSON()`. */ + interface CoauthoringLockData { + /** + * Gets the owner of the lock. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + owner?: Word.Interfaces.CoauthorData; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeData; + /** + * Gets a `CoauthoringLockType` value that represents the lock type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; + } + /** An interface describing the data returned by calling `coauthoringLockCollection.toJSON()`. */ + interface CoauthoringLockCollectionData { + items?: Word.Interfaces.CoauthoringLockData[]; + } + /** An interface describing the data returned by calling `coauthor.toJSON()`. */ + interface CoauthorData { + /** + * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + locks?: Word.Interfaces.CoauthoringLockData[]; + /** + * Gets the email address of the coauthor. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + emailAddress?: string; + /** + * Gets the unique identifier for the `Coauthor` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + id?: string; + /** + * Gets whether this author represents the current user. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isMe?: boolean; + /** + * Gets the display name of the coauthor. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + name?: string; + } + /** An interface describing the data returned by calling `coauthorCollection.toJSON()`. */ + interface CoauthorCollectionData { + items?: Word.Interfaces.CoauthorData[]; + } + /** An interface describing the data returned by calling `coauthoring.toJSON()`. */ + interface CoauthoringData { + /** + * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + authors?: Word.Interfaces.CoauthorData[]; + /** + * Gets a `ConflictCollection` object that represents all the conflicts in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + conflicts?: Word.Interfaces.ConflictData[]; + /** + * Gets a `CoauthoringLockCollection` object that represents the locks in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + locks?: Word.Interfaces.CoauthoringLockData[]; + /** + * Gets a `Coauthor` object that represents the current user. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + me?: Word.Interfaces.CoauthorData; + /** + * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + updates?: Word.Interfaces.CoauthoringUpdateData[]; + /** + * Gets whether this document can be coauthored. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + canCoauthor?: boolean; + /** + * Gets whether the document can be automatically merged. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + canMerge?: boolean; + /** + * Gets whether the document has pending updates that have not been accepted. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pendingUpdates?: boolean; + } + /** An interface describing the data returned by calling `coauthoringUpdate.toJSON()`. */ + interface CoauthoringUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeData; + } + /** An interface describing the data returned by calling `coauthoringUpdateCollection.toJSON()`. */ + interface CoauthoringUpdateCollectionData { + items?: Word.Interfaces.CoauthoringUpdateData[]; + } + /** An interface describing the data returned by calling `comment.toJSON()`. */ + interface CommentData { + /** + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeData; + /** + * Gets the collection of reply objects associated with the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + replies?: Word.Interfaces.CommentReplyData[]; + /** + * Gets the email of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorEmail?: string; + /** + * Gets the name of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorName?: string; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + /** + * Gets the creation date of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: Date; + /** + * Gets the ID of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: string; + /** + * Specifies the comment thread's status. Setting to `true` resolves the comment thread. Getting a value of `true` means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; + } + /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ + interface CommentCollectionData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ + interface CommentContentRangeData { + /** + * Specifies a value that indicates whether the comment text is bold. + * + * @remarks + * [Api set: WordApi 1.4] + */ + bold?: boolean; + /** + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + hyperlink?: string; + /** + * Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.4] + */ + isEmpty?: boolean; + /** + * Specifies a value that indicates whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic?: boolean; + /** + * Specifies a value that indicates whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough?: boolean; + /** + * Gets the text of the comment range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + text?: string; + /** + * Specifies a value that indicates the comment text's underline type. `none` if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface describing the data returned by calling `commentReply.toJSON()`. */ + interface CommentReplyData { + /** + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeData; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentData; + /** + * Gets the email of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorEmail?: string; + /** + * Gets the name of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorName?: string; + /** + * Specifies the comment reply's content. The string is plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + /** + * Gets the creation date of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: Date; + /** + * Gets the ID of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: string; + } + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ + interface CommentReplyCollectionData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface describing the data returned by calling `conditionalStyle.toJSON()`. */ + interface ConditionalStyleData { + /** + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bottomPadding?: number; + /** + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + leftPadding?: number; + /** + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + rightPadding?: number; + /** + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + topPadding?: number; + } + /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ + interface XmlMappingData { + /** + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customXmlNode?: Word.Interfaces.CustomXmlNodeData; + /** + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + customXmlPart?: Word.Interfaces.CustomXmlPartData; + /** + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isMapped?: boolean; + /** + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + prefixMappings?: string; + /** + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xpath?: string; + } + /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ + interface CustomXmlPrefixMappingCollectionData { + items?: Word.Interfaces.CustomXmlPrefixMappingData[]; + } + /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ + interface CustomXmlPrefixMappingData { + /** + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + namespaceUri?: string; + /** + * Gets the prefix for the `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + prefix?: string; + } + /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ + interface CustomXmlSchemaData { + /** + * Gets the location of the schema on a computer. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + location?: string; + /** + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + namespaceUri?: string; + } + /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ + interface CustomXmlSchemaCollectionData { + items?: Word.Interfaces.CustomXmlSchemaData[]; + } + /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ + interface CustomXmlNodeCollectionData { + items?: Word.Interfaces.CustomXmlNodeData[]; + } + /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ + interface CustomXmlNodeData { + /** + * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + attributes?: Word.Interfaces.CustomXmlNodeData[]; + /** + * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + childNodes?: Word.Interfaces.CustomXmlNodeData[]; + /** + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + firstChild?: Word.Interfaces.CustomXmlNodeData; + /** + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lastChild?: Word.Interfaces.CustomXmlNodeData; + /** + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nextSibling?: Word.Interfaces.CustomXmlNodeData; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + ownerPart?: Word.Interfaces.CustomXmlPartData; + /** + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + parentNode?: Word.Interfaces.CustomXmlNodeData; + /** + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + previousSibling?: Word.Interfaces.CustomXmlNodeData; + /** + * Gets the base name of the node without the namespace prefix, if one exists. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + baseName?: string; + /** + * Gets the unique address identifier for the namespace of the node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + namespaceUri?: string; + /** + * Gets the type of the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + /** + * Specifies the value of the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nodeValue?: string; + /** + * Specifies the text for the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + text?: string; + /** + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xpath?: string; + /** + * Gets the XML representation of the current node and its children. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xml?: string; + } + /** An interface describing the data returned by calling `contentControl.toJSON()`. */ + interface ContentControlData { + /** + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; + /** + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ + checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; + /** + * Gets the data of the content control when its type is `comboBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; + /** + * Gets the collection of `ContentControl` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; + /** + * Gets the data of the content control when its type is `dropDownList`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; + /** + * Gets the collection of `Field` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ + fields?: Word.Interfaces.FieldData[]; + /** + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontData; + /** + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + groupContentControl?: Word.Interfaces.GroupContentControlData; + /** + * Gets the collection of `InlinePicture` objects in the content control. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ + inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** + * Gets the collection of `List` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lists?: Word.Interfaces.ListData[]; + /** + * Gets the collection of `Paragraph` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pictureContentControl?: Word.Interfaces.PictureContentControlData; + /** + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; + /** + * Gets the collection of `Table` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ + tables?: Word.Interfaces.TableData[]; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xmlMapping?: Word.Interfaces.XmlMappingData; + /** + * Specifies the appearance of the content control. The value can be `boundingBox`, `tags`, or `hidden`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotDelete?: boolean; + /** + * Specifies a value that indicates whether the user can edit the contents of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotEdit?: boolean; + /** + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Gets an integer that represents the content control identifier. + * + * @remarks + * [Api set: WordApi 1.1] + */ + id?: number; + /** + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText?: string; + /** + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited?: boolean; + /** + * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the `styleBuiltIn` property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the `style` property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + /** + * Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag?: string; + /** + * Gets the text of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: string; + /** + * Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title?: string; + /** + * Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. + * + * @remarks + * [Api set: WordApi 1.1] + */ + type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + } + /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ + interface ContentControlCollectionData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ + interface ContentControlListItemData { + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; + } + /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ + interface ContentControlListItemCollectionData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface describing the data returned by calling `customProperty.toJSON()`. */ + interface CustomPropertyData { + /** + * Gets the key of the custom property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + key?: string; + /** + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: any; + } + /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ + interface CustomPropertyCollectionData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ + interface CustomXmlPartData { + /** + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + documentElement?: Word.Interfaces.CustomXmlNodeData; + /** + * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; + /** + * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; + /** + * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + builtIn?: boolean; + /** + * Gets the ID of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: string; + /** + * Gets the namespace URI of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + namespaceUri?: string; + /** + * Gets the XML representation of the current `CustomXmlPart` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xml?: string; + } + /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ + interface CustomXmlPartCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ + interface CustomXmlPartScopedCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `document.toJSON()`. */ + interface DocumentData { + /** + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activeWindow?: Word.Interfaces.WindowData; + /** + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bibliography?: Word.Interfaces.BibliographyData; + /** + * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ + body?: Word.Interfaces.BodyData; + /** + * Gets a `Coauthoring` object for managing coauthoring in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + coauthoring?: Word.Interfaces.CoauthoringData; + /** + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + /** + * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; + /** + * Returns a `FrameCollection` object that represents all the frames in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frames?: Word.Interfaces.FrameData[]; + /** + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hyperlinks?: Word.Interfaces.HyperlinkData[]; + /** + * Returns a `ListTemplateCollection` object that represents all the list templates in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + listTemplates?: Word.Interfaces.ListTemplateData[]; + /** + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageSetup?: Word.Interfaces.PageSetupData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesData; + /** + * Gets the collection of `Section` objects in the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + sections?: Word.Interfaces.SectionData[]; + /** + * Returns a `Selection` object that represents the current selection in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selection?: Word.Interfaces.SelectionData; + /** + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + settings?: Word.Interfaces.SettingData[]; + /** + * Gets the collection of `Word.Window` objects for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + windows?: Word.Interfaces.WindowData[]; + /** + * Gets the name of the active theme and formatting options. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + activeTheme?: string; + /** + * Gets the display name of the active theme. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + activeThemeDisplayName?: string; + /** + * Gets whether Word encrypts file properties for password-protected documents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areFilePropertiesPasswordEncrypted?: boolean; + /** + * Specifies whether grammatical errors are marked by a wavy green line in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areGrammaticalErrorsShown?: boolean; + /** + * Specifies whether to use the default math settings when creating new equations. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areMathDefaultsUsed?: boolean; + /** + * Specifies whether to disable features introduced after a specified version. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areNewerFeaturesDisabled?: boolean; + /** + * Specifies whether Microsoft Word underlines spelling errors in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areSpellingErrorsShown?: boolean; + /** + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areStylesUpdatedOnOpen?: boolean; + /** + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areTrueTypeFontsEmbedded?: boolean; + /** + * Specifies if automatic hyphenation is turned on for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + autoHyphenation?: boolean; + /** + * Specifies if the edits in the document are automatically saved. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + autoSaveOn?: boolean; + /** + * Specifies the ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + /** + * Gets the code name for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + codeName?: string; + /** + * Gets the compatibility mode that Word uses when opening the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + compatibilityMode?: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current"; + /** + * Specifies the maximum number of consecutive lines that can end with hyphens. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + consecutiveHyphensLimit?: number; + /** + * Gets a random number that Word assigns to changes in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + currentRsid?: number; + /** + * Specifies the interval (in points) between the default tab stops in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + defaultTabStop?: number; + /** + * Specifies the browser frame for displaying a webpage via hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + defaultTargetFrame?: string; + /** + * Specifies whether Word should not embed common system fonts. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + doNotEmbedSystemFonts?: boolean; + /** + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + encryptionProvider?: string; + /** + * Specifies the East Asian language used for line breaking. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + /** + * Specifies the line break control level. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + /** + * Specifies whether Word shows the next heading level when the previous is used. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formattingIsNextLevelShown?: boolean; + /** + * Specifies whether to show user-defined styles. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formattingIsUserStyleNameShown?: boolean; + /** + * Gets the name of a document, including the path. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fullName?: string; + /** + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridDistanceHorizontal?: number; + /** + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridDistanceVertical?: number; + /** + * Specifies whether the character grid starts from the upper-left corner of the page. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridIsOriginFromMargin?: boolean; + /** + * Specifies the horizontal origin point for the invisible grid. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridOriginHorizontal?: number; + /** + * Specifies the vertical origin point for the invisible grid. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridOriginVertical?: number; + /** + * Specifies the interval for horizontal character gridlines in print layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridSpaceBetweenHorizontalLines?: number; + /** + * Specifies the interval for vertical character gridlines in print layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + gridSpaceBetweenVerticalLines?: number; + /** + * Gets whether a password is required to open the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + hasPassword?: boolean; + /** + * Gets whether the document has an attached Microsoft Visual Basic for Applications project. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + hasVbProject?: boolean; + /** + * Specifies whether words in all capital letters can be hyphenated. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + hyphenateCaps?: boolean; + /** + * Specifies the width of the hyphenation zone, in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + hyphenationZone?: number; + /** + * Specifies whether automatic formatting options override formatting restrictions. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isAutoFormatOverrideOn?: boolean; + /** + * Specifies whether charts in the active document use cell-reference data-point tracking. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isChartDataPointTracked?: boolean; + /** + * Specifies whether the compatibility option specified by the `type` property is enabled. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isCompatible?: boolean; + /** + * Specifies whether the document is final. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFinal?: boolean; + /** + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFontsSubsetSaved?: boolean; + /** + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFormsDataPrinted?: boolean; + /** + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFormsDataSaved?: boolean; + /** + * Specifies whether a grammar check has been run on the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isGrammarChecked?: boolean; + /** + * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isInAutoSave?: boolean; + /** + * Gets whether the document is in form design mode. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isInFormsDesign?: boolean; + /** + * Specifies whether Word kerns half-width Latin characters and punctuation marks. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isKerningByAlgorithm?: boolean; + /** + * Specifies whether to embed speech and handwriting data. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isLinguisticDataEmbedded?: boolean; + /** + * Gets whether this document is a master document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isMasterDocument?: boolean; + /** + * Specifies whether Word optimizes the document for Word 97. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isOptimizedForWord97?: boolean; + /** + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isPostScriptPrintedOverText?: boolean; + /** + * Specifies whether users can change the Quick Style set. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isQuickStyleSetLocked?: boolean; + /** + * Gets whether changes to the document cannot be saved to the original document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isReadOnly?: boolean; + /** + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isReadOnlyRecommended?: boolean; + /** + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isSnappedToGrid?: boolean; + /** + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isSnappedToShapes?: boolean; + /** + * Specifies whether spelling has been checked throughout the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isSpellingChecked?: boolean; + /** + * Specifies whether formatting restrictions are enforced in a protected document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isStyleEnforced?: boolean; + /** + * Gets whether this document is a subdocument of a master document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isSubdocument?: boolean; + /** + * Specifies whether users can change the document theme. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isThemeLocked?: boolean; + /** + * Specifies whether the document was created or opened by the user. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isUserControl?: boolean; + /** + * Gets whether the VBA project is digitally signed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isVbaSigned?: boolean; + /** + * Gets whether the document is protected with a write password. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isWriteReserved?: boolean; + /** + * Specifies the character spacing adjustment. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + /** + * Specifies the format type that Microsoft Word uses when automatically formatting the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; + /** + * Specifies whether Microsoft Word has detected the language of the document text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageDetected?: boolean; + /** + * Specifies the kinsoku characters after which Word will not break a line. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + noLineBreakAfter?: string; + /** + * Specifies the kinsoku characters before which Word will not break a line. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + noLineBreakBefore?: string; + /** + * Gets the encoding used to open the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + openEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + /** + * Gets the title of the original document after legal-blackline comparison. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + originalDocumentTitle?: string; + /** + * Sets a password that must be supplied to open the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + password?: string; + /** + * Gets the algorithm used for password encryption. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + passwordEncryptionAlgorithm?: string; + /** + * Gets the key length used for password encryption. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + passwordEncryptionKeyLength?: number; + /** + * Gets the name of the password encryption provider. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + passwordEncryptionProvider?: string; + /** + * Gets the disk or the web path to the document (excludes the document name). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + path?: string; + /** + * Specifies whether revision marks are printed with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + printRevisions?: boolean; + /** + * Gets the protection type for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + protectionType?: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"; + /** + * Specifies the width of pages in reading layout view when frozen. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readingLayoutSizeX?: number; + /** + * Specifies the height of pages in reading layout view when frozen. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readingLayoutSizeY?: number; + /** + * Specifies whether pages in reading layout view are frozen for handwritten markup. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + readingModeIsLayoutFrozen?: boolean; + /** + * Specifies whether Word removes user information upon saving. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + removePersonalInformationOnSave?: boolean; + /** + * Gets the title of the revised document after legal-blackline comparison. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + revisedDocumentTitle?: string; + /** + * Specifies the encoding used when saving the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + /** + * Gets the file format of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + saveFormat?: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"; + /** + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. + * + * @remarks + * [Api set: WordApi 1.1] + */ + saved?: boolean; + /** + * Specifies the encoding for saving as encoded text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + /** + * Specifies how Word marks line and paragraph breaks in text files. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; + /** + * Specifies whether to track formatting changes when change tracking is on. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + trackFormatting?: boolean; + /** + * Specifies whether to mark moved text when Track Changes is on. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + trackMoves?: boolean; + /** + * Specifies whether changes are tracked in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + trackRevisions?: boolean; + /** + * Specifies whether to remove or store date and time metadata for tracked changes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + trackedChangesAreDateAndTimeRemoved?: boolean; + /** + * Gets the document type (template or document). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: Word.DocumentType | "Document" | "Template" | "Frameset"; + /** + * Sets a password for saving changes to the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + writePassword?: string; + /** + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + xmlAreAdvancedErrorsShown?: boolean; + /** + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + xmlIsXsltUsedWhenSaving?: boolean; + /** + * Specifies the path and file name for the XSLT to apply when saving a document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + xmlSaveThroughXslt?: string; + } + /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ + interface DocumentCreatedData { + /** + * Gets the `Body` object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + body?: Word.Interfaces.BodyData; + /** + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesData; + /** + * Gets the collection of `Section` objects in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + sections?: Word.Interfaces.SectionData[]; + /** + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + settings?: Word.Interfaces.SettingData[]; + /** + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + saved?: boolean; + } + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ + interface DocumentPropertiesData { + /** + * Gets the collection of custom properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + customProperties?: Word.Interfaces.CustomPropertyData[]; + /** + * Gets the application name of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + applicationName?: string; + /** + * Specifies the author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + author?: string; + /** + * Specifies the category of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + category?: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: string; + /** + * Gets the creation date of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + creationDate?: Date; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: string; + /** + * Specifies the keywords of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + keywords?: string; + /** + * Gets the last author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lastAuthor?: string; + /** + * Gets the last print date of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lastPrintDate?: Date; + /** + * Gets the last save time of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lastSaveTime?: Date; + /** + * Specifies the manager of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + manager?: string; + /** + * Gets the revision number of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + revisionNumber?: string; + /** + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * + * @remarks + * [Api set: WordApi 1.3] + */ + security?: number; + /** + * Specifies the subject of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subject?: string; + /** + * Gets the template of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + template?: string; + /** + * Specifies the title of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + title?: string; + } + /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ + interface DropDownListContentControlData { + } + /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ + interface ComboBoxContentControlData { + } + /** An interface describing the data returned by calling `field.toJSON()`. */ + interface FieldData { + /** + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeData; + /** + * Specifies the field's code instruction. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code?: string; + /** + * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data?: string; + /** + * Gets the field's kind. + * + * @remarks + * [Api set: WordApi 1.5] + */ + kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + /** + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked?: boolean; + /** + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + showCodes?: boolean; + /** + * Gets the field's type. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; + } + /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ + interface FieldCollectionData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface describing the data returned by calling `font.toJSON()`. */ + interface FontData { + /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + borders?: Word.Interfaces.BorderUniversalData[]; + /** + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + fill?: Word.Interfaces.FillFormatData; + /** + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + glow?: Word.Interfaces.GlowFormatData; + /** + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + line?: Word.Interfaces.LineFormatData; + /** + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + reflection?: Word.Interfaces.ReflectionFormatData; + /** + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textColor?: Word.Interfaces.ColorFormatData; + /** + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textShadow?: Word.Interfaces.ShadowFormatData; + /** + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; + /** + * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + allCaps?: boolean; + /** + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold?: boolean; + /** + * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + boldBidirectional?: boolean; + /** + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies a `ColorIndex` value that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies the color for the `Font` object in a right-to-left language document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether contextual alternates are enabled for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + contextualAlternates?: boolean; + /** + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + diacriticColor?: string; + /** + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + disableCharacterSpaceGrid?: boolean; + /** + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + /** + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + emboss?: boolean; + /** + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + /** + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + engrave?: boolean; + /** + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + hidden?: boolean; + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to `null`. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor?: string; + /** + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic?: boolean; + /** + * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + italicBidirectional?: boolean; + /** + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + kerning?: number; + /** + * Specifies the ligature setting for the `Font` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + /** + * Specifies the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + name?: string; + /** + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nameAscii?: string; + /** + * Specifies the font name in a right-to-left language document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nameBidirectional?: string; + /** + * Specifies the East Asian font name. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nameFarEast?: string; + /** + * Specifies the font used for characters with codes from 128 through 255. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nameOther?: string; + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + /** + * Specifies the number spacing setting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + /** + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + outline?: boolean; + /** + * Specifies the position of text (in points) relative to the base line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + position?: number; + /** + * Specifies the scaling percentage applied to the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + scaling?: number; + /** + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shadow?: boolean; + /** + * Specifies the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size?: number; + /** + * Specifies the font size in points for right-to-left text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sizeBidirectional?: number; + /** + * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + smallCaps?: boolean; + /** + * Specifies the spacing between characters. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spacing?: number; + /** + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies the stylistic set for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + /** + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript?: boolean; + /** + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript?: boolean; + /** + * Specifies the font's underline type. `none` if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + underlineColor?: string; + } + /** An interface describing the data returned by calling `headingStyle.toJSON()`. */ + interface HeadingStyleData { + /** + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + level?: number; + /** + * Specifies the name of style for a heading. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + name?: string; + } + /** An interface describing the data returned by calling `headingStyleCollection.toJSON()`. */ + interface HeadingStyleCollectionData { + items?: Word.Interfaces.HeadingStyleData[]; + } + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + interface HyperlinkData { + /** + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeData; + /** + * Specifies the address (for example, a file name or URL) of the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + address?: string; + /** + * Specifies the text string for the hyperlink's subject line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + emailSubject?: string; + /** + * Returns `true` if extra information is required to resolve the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isExtraInfoRequired?: boolean; + /** + * Returns the name of the `Hyperlink` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + name?: string; + /** + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + screenTip?: string; + /** + * Specifies a named location in the destination of the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + subAddress?: string; + /** + * Specifies the name of the frame or window in which to load the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + target?: string; + /** + * Specifies the hyperlink's visible text in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textToDisplay?: string; + /** + * Returns the hyperlink type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; + } + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + interface HyperlinkCollectionData { + items?: Word.Interfaces.HyperlinkData[]; + } + /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ + interface InlinePictureData { + /** + * Specifies a string that represents the alternative text associated with the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextDescription?: string; + /** + * Specifies a string that contains the title for the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextTitle?: string; + /** + * Specifies a number that describes the height of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + height?: number; + /** + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.1] + */ + hyperlink?: string; + /** + * Gets the format of the inline image. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + /** + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lockAspectRatio?: boolean; + /** + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + width?: number; + } + /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ + interface InlinePictureCollectionData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface describing the data returned by calling `linkFormat.toJSON()`. */ + interface LinkFormatData { + /** + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isAutoUpdated?: boolean; + /** + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isLocked?: boolean; + /** + * Specifies if the linked picture is saved with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isPictureSavedWithDocument?: boolean; + /** + * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sourceFullName?: string; + /** + * Gets the name of the source file for the linked OLE object, picture, or field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sourceName?: string; + /** + * Gets the path of the source file for the linked OLE object, picture, or field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + sourcePath?: string; + /** + * Gets the link type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; + } + /** An interface describing the data returned by calling `list.toJSON()`. */ + interface ListData { + /** + * Gets paragraphs in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * Gets the list's ID. + * + * @remarks + * [Api set: WordApi 1.3] + */ + id?: number; + /** + * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. + * + * @remarks + * [Api set: WordApi 1.3] + */ + levelExistences?: boolean[]; + /** + * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + levelTypes?: Word.ListLevelType[]; + } + /** An interface describing the data returned by calling `listCollection.toJSON()`. */ + interface ListCollectionData { + items?: Word.Interfaces.ListData[]; + } + /** An interface describing the data returned by calling `listItem.toJSON()`. */ + interface ListItemData { + /** + * Specifies the level of the item in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + level?: number; + /** + * Gets the list item bullet, number, or picture as a string. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listString?: string; + /** + * Gets the list item order number in relation to its siblings. + * + * @remarks + * [Api set: WordApi 1.3] + */ + siblingIndex?: number; + } + /** An interface describing the data returned by calling `listLevel.toJSON()`. */ + interface ListLevelData { + /** + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + font?: Word.Interfaces.FontData; + /** + * Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the name of the style that's linked to the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + linkedStyle?: string; + /** + * Specifies the number format for the list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberFormat?: string; + /** + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberPosition?: number; + /** + * Specifies the number style for the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + /** + * Specifies the list level that must appear before it restarts numbering at 1. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + resetOnHigher?: number; + /** + * Specifies the starting number for the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + startAt?: number; + /** + * Specifies the tab position for the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + tabPosition?: number; + /** + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + textPosition?: number; + /** + * Specifies the character inserted after the number for the list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; + } + /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ + interface ListLevelCollectionData { + items?: Word.Interfaces.ListLevelData[]; + } + /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ + interface ListTemplateData { + /** + * Gets a `ListLevelCollection` object that represents all the levels for the list template. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + listLevels?: Word.Interfaces.ListLevelData[]; + /** + * Specifies the name of the list template. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + name?: string; + /** + * Specifies whether the list template is outline numbered. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outlineNumbered?: boolean; + } + /** An interface describing the data returned by calling `noteItem.toJSON()`. */ + interface NoteItemData { + /** + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + body?: Word.Interfaces.BodyData; + /** + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + reference?: Word.Interfaces.RangeData; + /** + * Represents the note item type: footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: Word.NoteItemType | "Footnote" | "Endnote"; + } + /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ + interface NoteItemCollectionData { + items?: Word.Interfaces.NoteItemData[]; + } + /** An interface describing the data returned by calling `oleFormat.toJSON()`. */ + interface OleFormatData { + /** + * Specifies the class type for the specified OLE object, picture, or field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + classType?: string; + /** + * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + iconIndex?: number; + /** + * Specifies the text displayed below the icon for the OLE object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + iconLabel?: string; + /** + * Specifies the program file in which the icon for the OLE object is stored. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + iconName?: string; + /** + * Gets the path of the file in which the icon for the OLE object is stored. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + iconPath?: string; + /** + * Gets whether the specified object is displayed as an icon. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isDisplayedAsIcon?: boolean; + /** + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFormattingPreservedOnUpdate?: boolean; + /** + * Gets a string that's used to identify the portion of the source file that's being linked. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + label?: string; + /** + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + progId?: string; + } + /** An interface describing the data returned by calling `page.toJSON()`. */ + interface PageData { + /** + * Gets a `BreakCollection` object that represents the breaks on the page. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + breaks?: Word.Interfaces.BreakData[]; + /** + * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + height?: number; + /** + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + index?: number; + /** + * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + width?: number; + } + /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ + interface PageCollectionData { + items?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `pane.toJSON()`. */ + interface PaneData { + /** + * Gets the collection of pages in the pane. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + pages?: Word.Interfaces.PageData[]; + /** + * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + pagesEnclosingViewport?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ + interface PaneCollectionData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface describing the data returned by calling `window.toJSON()`. */ + interface WindowData { + /** + * Gets the next document window in the collection of open document windows. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + next?: Word.Interfaces.WindowData; + /** + * Gets the previous document window in the collection open document windows. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + previous?: Word.Interfaces.WindowData; + /** + * Specifies whether rulers are displayed for the window or pane. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areRulersDisplayed?: boolean; + /** + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areScreenTipsDisplayed?: boolean; + /** + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areThumbnailsDisplayed?: boolean; + /** + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + caption?: string; + /** + * Specifies the height of the window (in points). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + height?: number; + /** + * Specifies the horizontal scroll position as a percentage of the document width. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + horizontalPercentScrolled?: number; + /** + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + /** + * Gets the position of an item in a collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + index?: number; + /** + * Specifies whether the window is active. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isActive?: boolean; + /** + * Specifies whether the document map is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isDocumentMapVisible?: boolean; + /** + * Specifies whether the email message header is visible in the document window. The default value is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isEnvelopeVisible?: boolean; + /** + * Specifies whether a horizontal scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isHorizontalScrollBarDisplayed?: boolean; + /** + * Specifies whether the vertical scroll bar appears on the left side of the document window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isLeftScrollBarDisplayed?: boolean; + /** + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isRightRulerDisplayed?: boolean; + /** + * Specifies whether the window is split into multiple panes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isSplit?: boolean; + /** + * Specifies whether a vertical ruler is displayed for the window or pane. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isVerticalRulerDisplayed?: boolean; + /** + * Specifies whether a vertical scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isVerticalScrollBarDisplayed?: boolean; + /** + * Specifies whether the window is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isVisible?: boolean; + /** + * Specifies the horizontal position of the window, measured in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + left?: number; + /** + * Specifies how Microsoft Word displays source documents after a compare and merge process. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + /** + * Specifies the vertical split percentage for the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + splitVertical?: number; + /** + * Specifies the width of the style area in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + styleAreaWidth?: number; + /** + * Specifies the vertical position of the document window, in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + top?: number; + /** + * Gets the window type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: Word.WindowType | "Document" | "Template"; + /** + * Gets the height (in points) of the active working area in the document window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + usableHeight?: number; + /** + * Gets the width (in points) of the active working area in the document window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + usableWidth?: number; + /** + * Specifies the vertical scroll position as a percentage of the document length. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + verticalPercentScrolled?: number; + /** + * Specifies the width of the document window, in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + width?: number; + /** + * Gets an integer that represents the position of the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + windowNumber?: number; + } + /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ + interface WindowCollectionData { + items?: Word.Interfaces.WindowData[]; + } + /** An interface describing the data returned by calling `paragraph.toJSON()`. */ + interface ParagraphData { + /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + borders?: Word.Interfaces.BorderUniversalData[]; + /** + * Gets the collection of fields in the paragraph. + * + * @remarks + * [Api set: WordApi 1.4] + */ + fields?: Word.Interfaces.FieldData[]; + /** + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontData; + /** + * Gets the collection of `InlinePicture` objects in the paragraph. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ + inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listItem?: Word.Interfaces.ListItemData; + /** + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listItemOrNullObject?: Word.Interfaces.ListItemData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shading?: Word.Interfaces.ShadingUniversalData; + /** + * Gets the collection of `Shape` objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + */ + shapes?: Word.Interfaces.ShapeData[]; + /** + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent?: number; + /** + * Indicates the paragraph is the last one inside its parent body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isLastParagraph?: boolean; /** - * Specifies the width for the border. + * Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - } - /** An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`. */ - interface BorderUniversalUpdateData { + isListItem?: boolean; /** - * Specifies the graphical page-border design for the document. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + leftIndent?: number; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - artWidth?: number; + lineSpacing?: number; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - color?: string; + lineUnitAfter?: number; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + lineUnitBefore?: number; /** - * Specifies whether the border is visible. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - isVisible?: boolean; + outlineLevel?: number; /** - * Specifies the line style of the border. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + rightIndent?: number; /** - * Specifies the line width of an object's border. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; - } - /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ - interface BorderCollectionUpdateData { + spaceAfter?: number; /** - * Specifies the 24-bit color of the inside borders. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - insideBorderColor?: string; + spaceBefore?: number; /** - * Specifies the border type of the inside borders. + * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + style?: string; /** - * Specifies the width of the inside borders. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the 24-bit color of the outside borders. Color is specified in '#RRGGBB' format or by using the color name. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - outsideBorderColor?: string; + tableNestingLevel?: number; /** - * Specifies the border type of the outside borders. + * Gets the text of the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + text?: string; /** - * Specifies the width of the outside borders. + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.6] */ - outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - items?: Word.Interfaces.BorderData[]; - } - /** An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`. */ - interface BorderUniversalCollectionUpdateData { - items?: Word.Interfaces.BorderUniversalData[]; - } - /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ - interface BreakUpdateData { - /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeUpdateData; + uniqueLocalId?: string; } - /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ - interface BreakCollectionUpdateData { - items?: Word.Interfaces.BreakData[]; + /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ + interface ParagraphCollectionData { + items?: Word.Interfaces.ParagraphData[]; } - /** An interface for updating data on the `BuildingBlock` object, for use in `buildingBlock.set({ ... })`. */ - interface BuildingBlockUpdateData { + /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ + interface ParagraphFormatData { /** - * Specifies the description for the building block. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - description?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + firstLineIndent?: number; /** - * Specifies the name of the building block. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - name?: string; + keepTogether?: boolean; /** - * Specifies the contents of the building block. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - value?: string; - } - /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ - interface CheckboxContentControlUpdateData { + keepWithNext?: boolean; /** - * Specifies the current state of the checkbox. + * Specifies the left indent. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.5] */ - isChecked?: boolean; - } - /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ - interface CommentUpdateData { - /** - * Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + leftIndent?: number; /** - * Specifies the comment's content as plain text. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - content?: string; + lineSpacing?: number; /** - * Specifies the comment thread's status. Setting to `true` resolves the comment thread. Getting a value of `true` means that the comment thread is resolved. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - resolved?: boolean; - } - /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ - interface CommentCollectionUpdateData { - items?: Word.Interfaces.CommentData[]; - } - /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ - interface CommentContentRangeUpdateData { + lineUnitAfter?: number; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - bold?: boolean; + lineUnitBefore?: number; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - hyperlink?: string; + mirrorIndents?: boolean; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - italic?: boolean; + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - strikeThrough?: boolean; + rightIndent?: number; /** - * Specifies a value that indicates the comment text's underline type. `none` if the comment text isn't underlined. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; - } - /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ - interface CommentReplyUpdateData { - /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + spaceAfter?: number; /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentComment?: Word.Interfaces.CommentUpdateData; + * Specifies the spacing (in points) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceBefore?: number; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - content?: string; - } - /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ - interface CommentReplyCollectionUpdateData { - items?: Word.Interfaces.CommentReplyData[]; + widowControl?: boolean; } - /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ - interface XmlMappingUpdateData { + /** An interface describing the data returned by calling `range.toJSON()`. */ + interface RangeData { /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; - } - /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ - interface CustomXmlPrefixMappingCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPrefixMappingData[]; - } - /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ - interface CustomXmlSchemaCollectionUpdateData { - items?: Word.Interfaces.CustomXmlSchemaData[]; - } - /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ - interface CustomXmlNodeCollectionUpdateData { - items?: Word.Interfaces.CustomXmlNodeData[]; - } - /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ - interface CustomXmlNodeUpdateData { + conflicts?: Word.Interfaces.ConflictData[]; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Gets the collection of `Field` objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + fields?: Word.Interfaces.FieldData[]; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + font?: Word.Interfaces.FontData; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Gets a `FrameCollection` object that represents all the frames in the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + frames?: Word.Interfaces.FrameData[]; /** - * Gets the object representing the part associated with this node. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Gets the collection of `InlinePicture` objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.2] */ - parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; - /** - * Specifies the value of the current node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - nodeValue?: string; - /** - * Specifies the text for the current node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - text?: string; - } - /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ - interface ContentControlUpdateData { + listFormat?: Word.Interfaces.ListFormatData; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * Gets the collection of pages in the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; + pages?: Word.Interfaces.PageData[]; /** - * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * Gets the collection of sections in the range. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.3] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; + sections?: Word.Interfaces.SectionData[]; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Gets the collection of `Shape` objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontUpdateData; - /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * [Api set: WordApiDesktop 1.2] * - * @remarks - * [Api set: WordApiDesktop 1.3] + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. */ - groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + shapes?: Word.Interfaces.ShapeData[]; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * Gets a `TableColumnCollection` object that represents all the table columns in the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + tableColumns?: Word.Interfaces.TableColumnData[]; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + * Specifies whether the range is formatted as bold. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bold?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + * Specifies whether the range is formatted as bold in a right-to-left language document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + boldBidirectional?: boolean; /** - * Specifies the appearance of the content control. The value can be `boundingBox`, `tags`, or `hidden`. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. + * Specifies the character width of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - cannotDelete?: boolean; + characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - cannotEdit?: boolean; + combineCharacters?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - color?: string; + disableCharacterSpaceGrid?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - placeholderText?: string; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. + * Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - removeWhenEdited?: boolean; + end?: number; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the `styleBuiltIn` property. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - style?: string; + fitTextWidth?: number; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the `style` property. + * Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + grammarChecked?: boolean; /** - * Specifies a tag to identify a content control. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - tag?: string; + hasNoProofing?: boolean; /** - * Specifies the title for a content control. + * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - title?: string; - } - /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ - interface ContentControlCollectionUpdateData { - items?: Word.Interfaces.ContentControlData[]; - } - /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ - interface ContentControlListItemUpdateData { + highlightColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.4] */ - displayText?: string; + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Specifies the index location of a content control list item in the collection of list items. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.3] */ - index?: number; + hyperlink?: string; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies the ID for the range. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.4] */ - value?: string; - } - /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ - interface ContentControlListItemCollectionUpdateData { - items?: Word.Interfaces.ContentControlListItemData[]; - } - /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ - interface CustomPropertyUpdateData { + id?: string; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Checks whether the range length is zero. * * @remarks * [Api set: WordApi 1.3] */ - value?: any; - } - /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ - interface CustomPropertyCollectionUpdateData { - items?: Word.Interfaces.CustomPropertyData[]; - } - /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ - interface CustomXmlPartUpdateData { + isEmpty?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; - } - /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ - interface CustomXmlPartCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ - interface CustomXmlPartScopedCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ - interface DocumentUpdateData { + * Gets if the range is collapsed and is located at the end-of-row mark in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isEndOfRowMark?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - bibliography?: Word.Interfaces.BibliographyUpdateData; + * Gets whether the text in the range is visible on the screen. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isTextVisibleOnScreen?: boolean; /** - * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ - body?: Word.Interfaces.BodyUpdateData; + * Specifies if the font or range is formatted as italic. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + italic?: boolean; /** - * Returns a `PageSetup` object that's associated with the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + * Specifies if the font or range is formatted as italic (right-to-left languages). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + italicBidirectional?: boolean; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; + * Specifies whether the range of Japanese language text is hiragana or katakana. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + kana?: Word.Kana | "Katakana" | "Hiragana"; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies whether Microsoft Word has detected the language of the text in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageDetected?: boolean; + /** + * Specifies a `LanguageId` value that represents the language for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - autoHyphenation?: boolean; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies if the edits in the document are automatically saved. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApiDesktop 1.3] */ - autoSaveOn?: boolean; + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the ChangeTracking mode. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + showAll?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - consecutiveHyphensLimit?: number; + spellingChecked?: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - hyphenateCaps?: boolean; + start?: number; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageDetected?: boolean; - } - /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ - interface DocumentCreatedUpdateData { + storyLength?: number; /** - * Gets the `Body` object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - body?: Word.Interfaces.BodyUpdateData; + * Gets the story type for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; - } - /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ - interface DocumentPropertiesUpdateData { + * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; /** - * Specifies the author of the document. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ - author?: string; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the category of the document. + * Gets the text of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - category?: string; + text?: string; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - comments?: string; + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + } + /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ + interface RangeCollectionData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ + interface SearchOptionsData { /** - * Specifies the company of the document. + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - company?: string; + ignorePunct?: boolean; /** - * Specifies the format of the document. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - format?: string; + ignoreSpace?: boolean; /** - * Specifies the keywords of the document. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - keywords?: string; + matchCase?: boolean; /** - * Specifies the manager of the document. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - manager?: string; + matchPrefix?: boolean; /** - * Specifies the subject of the document. + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subject?: string; + matchSuffix?: boolean; /** - * Specifies the title of the document. + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - title?: string; + matchWholeWord?: boolean; + /** + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWildcards?: boolean; } - /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ - interface FieldUpdateData { + /** An interface describing the data returned by calling `section.toJSON()`. */ + interface SectionData { /** - * Gets the field's result data. + * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - result?: Word.Interfaces.RangeUpdateData; + body?: Word.Interfaces.BodyData; /** - * Specifies the field's code instruction. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. - */ - code?: string; + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageSetup?: Word.Interfaces.PageSetupData; + /** + * Specifies if the section is protected for forms. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - data?: string; + protectedForForms?: boolean; + } + /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ + interface SectionCollectionData { + items?: Word.Interfaces.SectionData[]; + } + /** An interface describing the data returned by calling `setting.toJSON()`. */ + interface SettingData { /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Gets the key of the setting. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.4] */ - locked?: boolean; + key?: string; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - showCodes?: boolean; + value?: any; } - /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ - interface FieldCollectionUpdateData { - items?: Word.Interfaces.FieldData[]; + /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ + interface SettingCollectionData { + items?: Word.Interfaces.SettingData[]; } - /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ - interface FontUpdateData { + /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ + interface StyleCollectionData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface describing the data returned by calling `style.toJSON()`. */ + interface StyleData { /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Specifies a `BorderCollection` object that represents all the borders for the style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - fill?: Word.Interfaces.FillFormatUpdateData; + borders?: Word.Interfaces.BorderData[]; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Gets a `Font` object that represents the character formatting of the style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - glow?: Word.Interfaces.GlowFormatUpdateData; + font?: Word.Interfaces.FontData; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - line?: Word.Interfaces.LineFormatUpdateData; + frame?: Word.Interfaces.FrameData; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - reflection?: Word.Interfaces.ReflectionFormatUpdateData; + linkStyle?: Word.Interfaces.StyleData; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Gets a `ListTemplate` object that represents the list formatting for the style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - textColor?: Word.Interfaces.ColorFormatUpdateData; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - textShadow?: Word.Interfaces.ShadowFormatUpdateData; + paragraphFormat?: Word.Interfaces.ParagraphFormatData; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; + shading?: Word.Interfaces.ShadingData; /** - * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * Gets a `TableStyle` object representing style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ + tableStyle?: Word.Interfaces.TableStyleData; + /** + * Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - allCaps?: boolean; + automaticallyUpdate?: boolean; /** - * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - bold?: boolean; + baseStyle?: string; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. + * Gets whether the style is a built-in style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + builtIn?: boolean; + /** + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - boldBidirectional?: boolean; + hasProofing?: boolean; /** - * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. + * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - color?: string; + inUse?: boolean; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies an East Asian language for the style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether contextual alternates are enabled for the font. + * Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - contextualAlternates?: boolean; + linked?: boolean; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Returns the list level for the style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - diacriticColor?: string; + listLevelNumber?: number; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApiDesktop 1.3] */ - disableCharacterSpaceGrid?: boolean; + locked?: boolean; /** - * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. + * Gets the name of the style in the language of the user. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - doubleStrikeThrough?: boolean; + nameLocal?: string; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - emboss?: boolean; + nextParagraphStyle?: string; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Specifies the priority. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - engrave?: boolean; + priority?: number; /** - * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - hidden?: boolean; + quickStyle?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to `null`. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Gets the style type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - highlightColor?: string; + type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. + * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - italic?: boolean; + unhideWhenUsed?: boolean; /** - * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - italicBidirectional?: boolean; + visibility?: boolean; + } + /** An interface describing the data returned by calling `shading.toJSON()`. */ + interface ShadingData { /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - kerning?: number; + backgroundPatternColor?: string; /** - * Specifies the ligature setting for the `Font` object. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + foregroundPatternColor?: string; /** - * Specifies the name of the font. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - name?: string; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ + interface ShadingUniversalData { /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nameAscii?: string; + backgroundPatternColor?: string; /** - * Specifies the font name in a right-to-left language document. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nameBidirectional?: string; + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the East Asian font name. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nameFarEast?: string; + foregroundPatternColor?: string; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nameOther?: string; + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the number form setting for an OpenType font. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks * [Api set: WordApiDesktop 1.3] */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface describing the data returned by calling `table.toJSON()`. */ + interface TableData { /** - * Specifies the number spacing setting for the font. + * Gets the collection of `Field` objects in the table. + * + * @remarks + * [Api set: WordApi 1.4] + */ + fields?: Word.Interfaces.FieldData[]; + /** + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + font?: Word.Interfaces.FontData; + /** + * Gets all of the table rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rows?: Word.Interfaces.TableRowData[]; + /** + * Gets the child tables nested one level deeper. + * + * @remarks + * [Api set: WordApi 1.3] + */ + tables?: Word.Interfaces.TableData[]; + /** + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Specifies the description of the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - outline?: boolean; + description?: string; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - position?: number; + headerRowCount?: number; /** - * Specifies the scaling percentage applied to the font. + * Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - scaling?: number; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Indicates whether all of the table rows are uniform. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isUniform?: boolean; + /** + * Gets the nesting level of the table. Top-level tables have level 1. + * + * @remarks + * [Api set: WordApi 1.3] + */ + nestingLevel?: number; + /** + * Gets the number of rows in the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rowCount?: number; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: string; + /** + * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + style?: string; + /** + * Specifies whether the table has banded columns. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedColumns?: boolean; + /** + * Specifies whether the table has banded rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedRows?: boolean; + /** + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - shadow?: boolean; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the font size in points. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - size?: number; + styleFirstColumn?: boolean; /** - * Specifies the font size in points for right-to-left text. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - sizeBidirectional?: number; + styleLastColumn?: boolean; /** - * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - smallCaps?: boolean; + styleTotalRow?: boolean; /** - * Specifies the spacing between characters. + * Specifies the title of the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spacing?: number; + title?: string; /** - * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - strikeThrough?: boolean; + values?: string[][]; /** - * Specifies the stylistic set for the font. + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - subscript?: boolean; + width?: number; + } + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ + interface TableStyleData { /** - * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - superscript?: boolean; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the font's underline type. `none` if the font isn't underlined. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + allowBreakAcrossPage?: boolean; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - underlineColor?: string; - } - /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ - interface HyperlinkUpdateData { - /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeUpdateData; + bottomCellMargin?: number; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - address?: string; + cellSpacing?: number; /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - emailSubject?: string; + columnStripe?: number; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - screenTip?: string; + isBreakAcrossPagesAllowed?: boolean; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - subAddress?: string; + leftCellMargin?: number; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - target?: string; + leftIndent?: number; /** - * Specifies the hyperlink's visible text in the document. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - textToDisplay?: string; - } - /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ - interface HyperlinkCollectionUpdateData { - items?: Word.Interfaces.HyperlinkData[]; - } - /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ - interface InlinePictureUpdateData { + rightCellMargin?: number; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - altTextDescription?: string; + rowStripe?: number; /** - * Specifies a string that contains the title for the inline image. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - altTextTitle?: string; + tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies a number that describes the height of the inline image. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - height?: number; + topCellMargin?: number; + } + /** An interface describing the data returned by calling `tabStop.toJSON()`. */ + interface TabStopData { /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - hyperlink?: string; + alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Gets whether this tab stop is a custom tab stop. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - lockAspectRatio?: boolean; + customTab?: boolean; /** - * Specifies a number that describes the width of the inline image. + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ - interface InlinePictureCollectionUpdateData { - items?: Word.Interfaces.InlinePictureData[]; - } - /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ - interface ListCollectionUpdateData { - items?: Word.Interfaces.ListData[]; - } - /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ - interface ListItemUpdateData { + leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the level of the item in the list. + * Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - level?: number; + position?: number; } - /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ - interface ListLevelUpdateData { + /** An interface describing the data returned by calling `tabStopCollection.toJSON()`. */ + interface TabStopCollectionData { + items?: Word.Interfaces.TabStopData[]; + } + /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ + interface TableCollectionData { + items?: Word.Interfaces.TableData[]; + } + /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ + interface TableColumnData { /** - * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - font?: Word.Interfaces.FontUpdateData; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shading?: Word.Interfaces.ShadingUniversalData; + /** + * Returns the position of this column in a collection. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + columnIndex?: number; /** - * Specifies the name of the style that's linked to the `ListLevel` object. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - linkedStyle?: string; + isFirst?: boolean; /** - * Specifies the number format for the list level. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - numberFormat?: string; + isLast?: boolean; /** - * Specifies the position (in points) of the number or bullet for the `ListLevel` object. + * Returns the nesting level of the column. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - numberPosition?: number; + nestingLevel?: number; /** - * Specifies the number style for the `ListLevel` object. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + preferredWidth?: number; /** - * Specifies the list level that must appear before it restarts numbering at 1. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - resetOnHigher?: number; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Specifies the starting number for the `ListLevel` object. + * Specifies the width of the column, in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - startAt?: number; + width?: number; + } + /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ + interface TableColumnCollectionData { + items?: Word.Interfaces.TableColumnData[]; + } + /** An interface describing the data returned by calling `tableOfAuthorities.toJSON()`. */ + interface TableOfAuthoritiesData { /** - * Specifies the tab position for the `ListLevel` object. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - tabPosition?: number; + bookmark?: string; /** - * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. + * 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - textPosition?: number; + category?: number; /** - * Specifies the character inserted after the number for the list level. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - } - /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ - interface ListLevelCollectionUpdateData { - items?: Word.Interfaces.ListLevelData[]; - } - /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ - interface ListTemplateUpdateData { + entrySeparator?: string; /** - * Specifies whether the list template is outline numbered. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - outlineNumbered?: boolean; - } - /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ - interface NoteItemUpdateData { - /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ - body?: Word.Interfaces.BodyUpdateData; - /** - * Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ - reference?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ - interface NoteItemCollectionUpdateData { - items?: Word.Interfaces.NoteItemData[]; - } - /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ - interface PageCollectionUpdateData { - items?: Word.Interfaces.PageData[]; - } - /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ - interface PaneCollectionUpdateData { - items?: Word.Interfaces.PaneData[]; - } - /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ - interface WindowCollectionUpdateData { - items?: Word.Interfaces.WindowData[]; - } - /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ - interface ParagraphUpdateData { + isCategoryHeaderIncluded?: boolean; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontUpdateData; + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isEntryFormattingKept?: boolean; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItem?: Word.Interfaces.ListItemUpdateData; + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isPassimUsed?: boolean; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pageNumberSeparator?: string; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pageRangeSeparator?: string; /** - * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + sequenceName?: string; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - firstLineIndent?: number; + sequenceSeparator?: string; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - leftIndent?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCollection.toJSON()`. */ + interface TableOfAuthoritiesCollectionData { + items?: Word.Interfaces.TableOfAuthoritiesData[]; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCategory.toJSON()`. */ + interface TableOfAuthoritiesCategoryData { /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - lineSpacing?: number; + name?: string; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCategoryCollection.toJSON()`. */ + interface TableOfAuthoritiesCategoryCollectionData { + items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; + } + /** An interface describing the data returned by calling `tableOfContents.toJSON()`. */ + interface TableOfContentsData { /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - lineUnitAfter?: number; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - lineUnitBefore?: number; + areFieldsUsed?: boolean; /** - * Specifies the outline level for the paragraph. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - outlineLevel?: number; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - rightIndent?: number; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - spaceAfter?: number; + arePageNumbersIncluded?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - spaceBefore?: number; + arePageNumbersRightAligned?: boolean; /** - * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - style?: string; + lowerHeadingLevel?: number; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - } - /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ - interface ParagraphCollectionUpdateData { - items?: Word.Interfaces.ParagraphData[]; - } - /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ - interface ParagraphFormatUpdateData { + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the alignment for the specified paragraphs. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + tableId?: string; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - firstLineIndent?: number; + upperHeadingLevel?: number; + } + /** An interface describing the data returned by calling `tableOfContentsCollection.toJSON()`. */ + interface TableOfContentsCollectionData { + items?: Word.Interfaces.TableOfContentsData[]; + } + /** An interface describing the data returned by calling `tableOfFigures.toJSON()`. */ + interface TableOfFiguresData { /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - keepTogether?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - keepWithNext?: boolean; + areFieldsUsed?: boolean; /** - * Specifies the left indent. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - leftIndent?: number; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - lineSpacing?: number; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - lineUnitAfter?: number; + arePageNumbersIncluded?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - lineUnitBefore?: number; + arePageNumbersRightAligned?: boolean; /** - * Specifies whether left and right indents are the same width. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - mirrorIndents?: boolean; + captionLabel?: string; /** - * Specifies the outline level for the specified paragraphs. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + isLabelIncluded?: boolean; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - rightIndent?: number; + lowerHeadingLevel?: number; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - spaceAfter?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - spaceBefore?: number; + tableId?: string; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - widowControl?: boolean; + upperHeadingLevel?: number; } - /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ - interface RangeUpdateData { + /** An interface describing the data returned by calling `tableOfFiguresCollection.toJSON()`. */ + interface TableOfFiguresCollectionData { + items?: Word.Interfaces.TableOfFiguresData[]; + } + /** An interface describing the data returned by calling `tableRow.toJSON()`. */ + interface TableRowData { /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Gets cells. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontUpdateData; + cells?: Word.Interfaces.TableCellData[]; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Gets the collection of `Field` objects in the table row. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - listFormat?: Word.Interfaces.ListFormatUpdateData; + fields?: Word.Interfaces.FieldData[]; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + font?: Word.Interfaces.FontData; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - hasNoProofing?: boolean; + cellCount?: number; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] */ - hyperlink?: string; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - languageDetected?: boolean; + isHeader?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + preferredHeight?: number; /** - * Specifies an East Asian language for the range. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + rowIndex?: number; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + shadingColor?: string; /** - * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: string; + values?: string[][]; + /** + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ + interface TableRowCollectionData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface describing the data returned by calling `tableCell.toJSON()`. */ + interface TableCellData { + /** + * Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + body?: Word.Interfaces.BodyData; + /** + * Gets the index of the cell in its row. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cellIndex?: number; + /** + * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + */ + columnWidth?: number; + /** + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets the index of the cell's row in the table. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - } - /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ - interface RangeCollectionUpdateData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ - interface SearchOptionsUpdateData { + rowIndex?: number; /** - * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - ignorePunct?: boolean; + shadingColor?: string; /** - * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - ignoreSpace?: boolean; + value?: string; /** - * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchCase?: boolean; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchPrefix?: boolean; + width?: number; + } + /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ + interface TableCellCollectionData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ + interface TableBorderData { /** - * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. + * Specifies the table border color. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchSuffix?: boolean; + color?: string; /** - * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchWholeWord?: boolean; + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchWildcards?: boolean; + width?: number; } - /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ - interface SectionUpdateData { - /** - * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ - body?: Word.Interfaces.BodyUpdateData; - /** - * Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** An interface describing the data returned by calling `template.toJSON()`. */ + interface TemplateData { /** - * Specifies if the section is protected for forms. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks * [Api set: WordApiDesktop 1.3] */ - protectedForForms?: boolean; - } - /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ - interface SectionCollectionUpdateData { - items?: Word.Interfaces.SectionData[]; - } - /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ - interface SettingUpdateData { + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Specifies the value of the setting. + * Specifies the line break control level for the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - value?: any; - } - /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ - interface SettingCollectionUpdateData { - items?: Word.Interfaces.SettingData[]; - } - /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ - interface StyleCollectionUpdateData { - items?: Word.Interfaces.StyleData[]; - } - /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ - interface StyleUpdateData { - /** - * Specifies a `BorderCollection` object that represents all the borders for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - borders?: Word.Interfaces.BorderCollectionUpdateData; - /** - * Gets a `Font` object that represents the character formatting of the style. - * - * @remarks - * [Api set: WordApi 1.5] - */ - font?: Word.Interfaces.FontUpdateData; - /** - * Returns a `Frame` object that represents the frame formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - frame?: Word.Interfaces.FrameUpdateData; - /** - * Specifies a link between a paragraph and a character style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - linkStyle?: Word.Interfaces.StyleUpdateData; - /** - * Gets a `ListTemplate` object that represents the list formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; - /** - * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. - * - * @remarks - * [Api set: WordApi 1.5] - */ - paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; - /** - * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. - * - * @remarks - * [Api set: WordApi 1.6] - */ - shading?: Word.Interfaces.ShadingUpdateData; - /** - * Gets a `TableStyle` object representing style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ - tableStyle?: Word.Interfaces.TableStyleUpdateData; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies whether the style is automatically redefined based on the selection. + * Returns the name of the template, including the drive or Web path. * * @remarks * [Api set: WordApiDesktop 1.3] */ - automaticallyUpdate?: boolean; + fullName?: string; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApiDesktop 1.3] */ - baseStyle?: string; + hasNoProofing?: boolean; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies the character spacing adjustment for the template. * * @remarks * [Api set: WordApiDesktop 1.3] */ - hasProofing?: boolean; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + kerningByAlgorithm?: boolean; /** - * Specifies an East Asian language for the style. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks * [Api set: WordApiDesktop 1.3] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether the style cannot be changed or edited. + * Specifies an East Asian language for the language in the template. * * @remarks * [Api set: WordApiDesktop 1.3] */ - locked?: boolean; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. + * Returns only the name of the document template (excluding any path or other location information). * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApiDesktop 1.3] */ - nextParagraphStyle?: string; + name?: string; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + noLineBreakAfter?: string; /** - * Specifies the priority. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - priority?: number; + noLineBreakBefore?: string; /** - * Specifies whether the style corresponds to an available quick style. + * Returns the path to the document template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - quickStyle?: boolean; + path?: string; /** - * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - unhideWhenUsed?: boolean; + saved?: boolean; /** - * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Returns the template type. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - visibility?: boolean; + type?: Word.TemplateType | "Normal" | "Global" | "Attached"; } - /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ - interface ShadingUpdateData { + /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ + interface TemplateCollectionData { + items?: Word.Interfaces.TemplateData[]; + } + /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ + interface TrackedChangeData { /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the author of the tracked change. * * @remarks * [Api set: WordApi 1.6] */ - backgroundPatternColor?: string; + author?: string; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.6] */ - foregroundPatternColor?: string; + date?: Date; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.6] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ - interface ShadingUniversalUpdateData { + text?: string; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Gets the type of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - backgroundPatternColor?: string; + type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + } + /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ + interface TrackedChangeCollectionData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface describing the data returned by calling `view.toJSON()`. */ + interface ViewData { /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + areAllNonprintingCharactersDisplayed?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - foregroundPatternColor?: string; + areBackgroundsDisplayed?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + areBookmarksIndicated?: boolean; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ - interface TableUpdateData { + areCommentsDisplayed?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - font?: Word.Interfaces.FontUpdateData; - /** - * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * Specifies the number of header rows. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - headerRowCount?: number; + areCropMarksDisplayed?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. + * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areDrawingsDisplayed?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - shadingColor?: string; + areEditableRangesShaded?: boolean; /** - * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies whether field codes are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - style?: string; + areFieldCodesDisplayed?: boolean; /** - * Specifies whether the table has banded columns. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleBandedColumns?: boolean; + areFormatChangesDisplayed?: boolean; /** - * Specifies whether the table has banded rows. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleBandedRows?: boolean; + areInkAnnotationsDisplayed?: boolean; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * Specifies whether the table has a first column with a special style. + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleFirstColumn?: boolean; + areLinesWrappedToWindow?: boolean; /** - * Specifies whether the table has a last column with a special style. + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleLastColumn?: boolean; + areObjectAnchorsDisplayed?: boolean; /** - * Specifies whether the table has a total (last) row with a special style. + * Gets whether Microsoft Word displays optional line breaks. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleTotalRow?: boolean; + areOptionalBreaksDisplayed?: boolean; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - values?: string[][]; + areOptionalHyphensDisplayed?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. + * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + areOtherAuthorsVisible?: boolean; /** - * Specifies the width of the table in points. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ - interface TableStyleUpdateData { + arePageBoundariesDisplayed?: boolean; /** - * Specifies the table's alignment against the page margin. + * Gets whether paragraph marks are displayed. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areParagraphsMarksDisplayed?: boolean; /** - * Specifies whether lines in tables formatted with a style break across pages. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - allowBreakAcrossPage?: boolean; + arePicturePlaceholdersDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - bottomCellMargin?: number; + areRevisionsAndCommentsDisplayed?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * Gets whether space characters are displayed. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - cellSpacing?: number; + areSpacesIndicated?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies whether table gridlines are displayed. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - leftCellMargin?: number; + areTableGridlinesDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Gets whether tab characters are displayed. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - rightCellMargin?: number; + areTabsDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - topCellMargin?: number; - } - /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ - interface TableCollectionUpdateData { - items?: Word.Interfaces.TableData[]; - } - /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ - interface TableColumnUpdateData { + areTextBoundariesDisplayed?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; - /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredWidth?: number; + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Gets on-screen shading for fields. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Specifies the width of the column, in points. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ - interface TableColumnCollectionUpdateData { - items?: Word.Interfaces.TableColumnData[]; - } - /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ - interface TableRowUpdateData { + isDraft?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - font?: Word.Interfaces.FontUpdateData; - /** - * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + isFirstLineOnlyDisplayed?: boolean; /** - * Specifies the preferred height of the row in points. + * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredHeight?: number; + isFormatDisplayed?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - shadingColor?: string; + isFullScreen?: boolean; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Gets whether text formatted as hidden text is displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - values?: string[][]; + isHiddenTextDisplayed?: boolean; /** - * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. + * Gets whether highlight formatting is displayed and printed with the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ - interface TableRowCollectionUpdateData { - items?: Word.Interfaces.TableRowData[]; - } - /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ - interface TableCellUpdateData { - /** - * Gets the `Body` object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - body?: Word.Interfaces.BodyUpdateData; + isHighlightingDisplayed?: boolean; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - columnWidth?: number; + isInConflictMode?: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + isInPanning?: boolean; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies whether the document is being viewed in reading layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - shadingColor?: string; + isInReadingLayout?: boolean; /** - * Specifies the text of the cell. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - value?: string; + isMailMergeDataView?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ - interface TableCellCollectionUpdateData { - items?: Word.Interfaces.TableCellData[]; - } - /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ - interface TableBorderUpdateData { + isMainTextLayerVisible?: boolean; /** - * Specifies the table border color. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - color?: string; + isPointerShownAsMagnifier?: boolean; /** - * Specifies the type of the table border. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + isReadingLayoutActualView?: boolean; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies whether XML tags are visible in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ - interface TemplateUpdateData { + isXmlMarkupVisible?: boolean; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies the display mode for tracked changes. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Specifies the line break control level for the document. + * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies the page movement type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - hasNoProofing?: boolean; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies the character spacing adjustment for the template. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - kerningByAlgorithm?: boolean; + revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Specifies the width of the revision balloons. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + revisionsBalloonWidth?: number; /** - * Specifies an East Asian language for the language in the template. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies the document element displayed in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - noLineBreakAfter?: string; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies the active window pane. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - noLineBreakBefore?: string; + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies the view type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - saved?: boolean; - } - /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ - interface TemplateCollectionUpdateData { - items?: Word.Interfaces.TemplateData[]; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; } - /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ - interface TrackedChangeCollectionUpdateData { - items?: Word.Interfaces.TrackedChangeData[]; - } - /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ - interface ShapeUpdateData { + /** An interface describing the data returned by calling `shape.toJSON()`. */ + interface ShapeData { /** * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyUpdateData; + body?: Word.Interfaces.BodyData; /** * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApiDesktop 1.2] */ - canvas?: Word.Interfaces.CanvasUpdateData; + canvas?: Word.Interfaces.CanvasData; /** * Returns the fill formatting of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ - fill?: Word.Interfaces.ShapeFillUpdateData; + fill?: Word.Interfaces.ShapeFillData; /** * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks * [Api set: WordApiDesktop 1.2] */ - parentCanvas?: Word.Interfaces.ShapeUpdateData; + parentCanvas?: Word.Interfaces.ShapeData; /** * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks * [Api set: WordApiDesktop 1.2] */ - parentGroup?: Word.Interfaces.ShapeUpdateData; + parentGroup?: Word.Interfaces.ShapeData; /** * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApiDesktop 1.2] */ - shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; + shapeGroup?: Word.Interfaces.ShapeGroupData; /** * Gets the `TextFrame` object of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ - textFrame?: Word.Interfaces.TextFrameUpdateData; + textFrame?: Word.Interfaces.TextFrameData; /** * Returns the text wrap formatting of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ - textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; + textWrap?: Word.Interfaces.ShapeTextWrapData; /** * Specifies whether a given shape can overlap other shapes. * @@ -127652,6 +150908,20 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ heightRelative?: number; + /** + * Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + id?: number; + /** + * Check whether this shape is a child of a group shape or a canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + isChild?: boolean; /** * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * @@ -127729,6 +150999,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ topRelative?: number; + /** + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** * Specifies if the shape is visible. Not applicable to inline shapes. * @@ -127751,32 +151028,60 @@ declare namespace Word { */ widthRelative?: number; } - /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ - interface ShapeGroupUpdateData { + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ + interface ShapeGroupData { /** * Gets the `Shape` object associated with the group. * * @remarks * [Api set: WordApiDesktop 1.2] */ - shape?: Word.Interfaces.ShapeUpdateData; + shape?: Word.Interfaces.ShapeData; + /** + * Gets the collection of `Shape` objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shapes?: Word.Interfaces.ShapeData[]; + /** + * Gets an integer that represents the shape group identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + id?: number; } - /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ - interface CanvasUpdateData { + /** An interface describing the data returned by calling `canvas.toJSON()`. */ + interface CanvasData { /** * Gets the `Shape` object associated with the canvas. * * @remarks * [Api set: WordApiDesktop 1.2] */ - shape?: Word.Interfaces.ShapeUpdateData; + shape?: Word.Interfaces.ShapeData; + /** + * Gets the collection of {@link Word.Shape} objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shapes?: Word.Interfaces.ShapeData[]; + /** + * Gets an integer that represents the canvas identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + id?: number; } - /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ - interface ShapeCollectionUpdateData { + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ + interface ShapeCollectionData { items?: Word.Interfaces.ShapeData[]; } - /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ - interface ShapeFillUpdateData { + /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ + interface ShapeFillData { /** * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * @@ -127798,9 +151103,16 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ transparency?: number; + /** + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; } - /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ - interface TextFrameUpdateData { + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ + interface TextFrameData { /** * Specifies the automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * @@ -127815,6 +151127,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ bottomMargin?: number; + /** + * Returns `true` if the text frame contains text, otherwise, `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + hasText?: boolean; /** * Specifies the left margin, in points, of the text frame. * @@ -127865,8 +151184,8 @@ declare namespace Word { */ wordWrap?: boolean; } - /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ - interface ShapeTextWrapUpdateData { + /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ + interface ShapeTextWrapData { /** * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * @@ -127910,39 +151229,126 @@ declare namespace Word { */ type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; } - /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ - interface RepeatingSectionItemUpdateData { + /** An interface describing the data returned by calling `reviewer.toJSON()`. */ + interface ReviewerData { + /** + * Specifies if the `Reviewer` object is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isVisible?: boolean; + } + /** An interface describing the data returned by calling `reviewerCollection.toJSON()`. */ + interface ReviewerCollectionData { + items?: Word.Interfaces.ReviewerData[]; + } + /** An interface describing the data returned by calling `revisionsFilter.toJSON()`. */ + interface RevisionsFilterData { + /** + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; + /** + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ + interface RepeatingSectionItemData { /** * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeUpdateData; + range?: Word.Interfaces.RangeData; } - /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ - interface DatePickerContentControlUpdateData { + /** An interface describing the data returned by calling `revision.toJSON()`. */ + interface RevisionData { + /** + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + movedRange?: Word.Interfaces.RangeData; + /** + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeData; + /** + * Gets the name of the user who made the tracked change. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + author?: string; + /** + * Gets the date and time when the tracked change was made. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + date?: Date; + /** + * Gets the description of tracked formatting changes in the revision. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formatDescription?: string; + /** + * Gets a number that represents the position of this item in a collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + index?: number; + /** + * Gets the revision type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + } + /** An interface describing the data returned by calling `revisionCollection.toJSON()`. */ + interface RevisionCollectionData { + items?: Word.Interfaces.RevisionData[]; + } + /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ + interface DatePickerContentControlData { /** * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + placeholderText?: Word.Interfaces.BuildingBlockData; /** * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeUpdateData; + range?: Word.Interfaces.RangeData; /** * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. * @@ -127985,6 +151391,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + /** + * Gets the identification for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + id?: string; /** * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * @@ -127992,6 +151405,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ isTemporary?: boolean; + /** + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * @@ -128006,6 +151426,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ lockContents?: boolean; + /** + * Gets whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + showingPlaceholderText?: boolean; /** * Specifies a tag to identify the content control. * @@ -128021,29 +151448,29 @@ declare namespace Word { */ title?: string; } - /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ - interface PictureContentControlUpdateData { + /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ + interface PictureContentControlData { /** * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + placeholderText?: Word.Interfaces.BuildingBlockData; /** * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeUpdateData; + range?: Word.Interfaces.RangeData; /** * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. * @@ -128058,6 +151485,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ color?: string; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + id?: string; /** * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * @@ -128065,6 +151499,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ isTemporary?: boolean; + /** + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * @@ -128079,6 +151520,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ lockContents?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + showingPlaceholderText?: boolean; /** * Specifies a tag to identify the content control. * @@ -128094,29 +151542,29 @@ declare namespace Word { */ title?: string; } - /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ - interface GroupContentControlUpdateData { + /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ + interface GroupContentControlData { /** * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + placeholderText?: Word.Interfaces.BuildingBlockData; /** * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeUpdateData; + range?: Word.Interfaces.RangeData; /** * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. * @@ -128131,6 +151579,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ color?: string; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + id?: string; /** * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * @@ -128138,6 +151593,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ isTemporary?: boolean; + /** + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * @@ -128152,6 +151614,13 @@ declare namespace Word { * [Api set: WordApiDesktop 1.3] */ lockContents?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + showingPlaceholderText?: boolean; /** * Specifies a tag to identify the content control. * @@ -128167,29 +151636,29 @@ declare namespace Word { */ title?: string; } - /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ - interface BuildingBlockGalleryContentControlUpdateData { + /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ + interface BuildingBlockGalleryContentControlData { /** * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + placeholderText?: Word.Interfaces.BuildingBlockData; /** * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeUpdateData; + range?: Word.Interfaces.RangeData; /** * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. * @@ -128219,85 +151688,26 @@ declare namespace Word { */ color?: string; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - isTemporary?: boolean; - /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - lockContentControl?: boolean; - /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - lockContents?: boolean; - /** - * Specifies a tag to identify the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - tag?: string; - /** - * Specifies the title for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - title?: string; - } - /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ - interface RepeatingSectionContentControlUpdateData { - /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; - /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeUpdateData; - /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - allowInsertDeleteSection?: boolean; - /** - * Specifies the appearance of the content control. + * Gets the identification for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + id?: string; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - color?: string; + isTemporary?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isTemporary?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * @@ -128313,12 +151723,12 @@ declare namespace Word { */ lockContents?: boolean; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Gets if the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApiDesktop 1.3] */ - repeatingSectionItemTitle?: string; + showingPlaceholderText?: boolean; /** * Specifies a tag to identify the content control. * @@ -128334,15854 +151744,15840 @@ declare namespace Word { */ title?: string; } - /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ - interface FrameUpdateData { + /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ + interface RepeatingSectionContentControlData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeUpdateData; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; - /** - * Specifies the height (in points) of the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - height?: number; + range?: Word.Interfaces.RangeData; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks * [Api set: WordApiDesktop 1.3] */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + allowInsertDeleteSection?: boolean; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - horizontalDistanceFromText?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - horizontalPosition?: number; + color?: string; /** - * Specifies if the frame is locked. + * Returns the identification for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockAnchor?: boolean; + id?: string; /** - * Specifies the relative horizontal position of the frame. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + isTemporary?: boolean; /** - * Specifies the relative vertical position of the frame. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApiDesktop 1.3] */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies if document text wraps around the frame. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textWrap?: boolean; + lockContentControl?: boolean; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApiDesktop 1.3] */ - verticalDistanceFromText?: number; + lockContents?: boolean; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - verticalPosition?: number; + repeatingSectionItemTitle?: string; /** - * Specifies the width (in points) of the frame. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApiDesktop 1.3] */ - width?: number; + showingPlaceholderText?: boolean; /** - * Specifies the rule used to determine the width of the frame. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; - } - /** An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`. */ - interface FrameCollectionUpdateData { - items?: Word.Interfaces.FrameData[]; - } - /** An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`. */ - interface DocumentLibraryVersionCollectionUpdateData { - items?: Word.Interfaces.DocumentLibraryVersionData[]; - } - /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ - interface ListFormatUpdateData { - /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + tag?: string; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Specifies the title for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - listLevelNumber?: number; + title?: string; } - /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ - interface FillFormatUpdateData { - /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** An interface describing the data returned by calling `readabilityStatistic.toJSON()`. */ + interface ReadabilityStatisticData { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; - /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Returns the name of the readability statistic. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - gradientAngle?: number; - /** - * Specifies if the object, or the formatting applied to it, is visible. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - isVisible?: boolean; + name?: string; /** - * Specifies whether the fill rotates with the shape. + * Returns the value of the grammar statistic. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - rotateWithObject?: boolean; + value?: number; + } + /** An interface describing the data returned by calling `readabilityStatisticCollection.toJSON()`. */ + interface ReadabilityStatisticCollectionData { + items?: Word.Interfaces.ReadabilityStatisticData[]; + } + /** An interface describing the data returned by calling `webSettings.toJSON()`. */ + interface WebSettingsData { /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + allowPng?: boolean; /** - * Specifies the horizontal scaling factor for the texture fill. + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureHorizontalScale?: number; + encoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureOffsetX?: number; + folderSuffix?: string; /** - * Specifies the vertical offset of the texture. + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureOffsetY?: number; + organizeInFolder?: boolean; /** - * Specifies whether the texture is tiled. + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureTile?: boolean; + pixelsPerInch?: number; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - textureVerticalScale?: number; + relyOnCSS?: boolean; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - transparency?: number; - } - /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ - interface GlowFormatUpdateData { - /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - color?: Word.Interfaces.ColorFormatUpdateData; + relyOnVectorMarkupLanguage?: boolean; /** - * Specifies the length of the radius for a glow effect. + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - radius?: number; + screenSize?: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the target browser for documents viewed in a web browser. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - transparency?: number; - } - /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ - interface LineFormatUpdateData { - /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; - /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + targetBrowser?: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** - * Specifies the length of the arrowhead at the beginning of the line. + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + useLongFileNames?: boolean; + } + /** An interface describing the data returned by calling `xmlNodeCollection.toJSON()`. */ + interface XmlNodeCollectionData { + items?: Word.Interfaces.XmlNodeData[]; + } + /** An interface describing the data returned by calling `xmlNode.toJSON()`. */ + interface XmlNodeData { /** - * Specifies the style of the arrowhead at the beginning of the line. + * Gets the name of the element without any prefix. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + baseName?: string; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + hasChildNodes?: boolean; /** - * Specifies the dash style for the line. + * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + level?: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies the length of the arrowhead at the end of the line. + * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + namespaceUri?: string; /** - * Specifies the style of the arrowhead at the end of the line. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + placeholderText?: string; /** - * Specifies the width of the arrowhead at the end of the line. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + text?: string; /** - * Specifies if to draw lines inside a shape. + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - insetPen?: boolean; + validationErrorText?: string; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isVisible?: boolean; + validationStatus?: Word.XmlValidationStatus | "Ok" | "Custom"; + } + /** An interface describing the data returned by calling `htmlDivision.toJSON()`. */ + interface HtmlDivisionData { /** - * Specifies the pattern applied to the line. + * Specifies the left indent value (in points) for this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + leftIndent?: number; /** - * Specifies the line format style. + * Specifies the right indent (in points) for this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + rightIndent?: number; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the amount of spacing (in points) after this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - transparency?: number; + spaceAfter?: number; /** - * Specifies the thickness of the line in points. + * Specifies the spacing (in points) before this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - weight?: number; + spaceBefore?: number; } - /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ - interface ReflectionFormatUpdateData { + /** An interface describing the data returned by calling `htmlDivisionCollection.toJSON()`. */ + interface HtmlDivisionCollectionData { + items?: Word.Interfaces.HtmlDivisionData[]; + } + /** An interface describing the data returned by calling `frame.toJSON()`. */ + interface FrameData { /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + borders?: Word.Interfaces.BorderUniversalData[]; + /** + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shading?: Word.Interfaces.ShadingUniversalData; + /** + * Specifies the height (in points) of the frame. * * @remarks * [Api set: WordApiDesktop 1.3] */ - blur?: number; + height?: number; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks * [Api set: WordApiDesktop 1.3] */ - offset?: number; + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - size?: number; + horizontalDistanceFromText?: number; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks * [Api set: WordApiDesktop 1.3] */ - transparency?: number; + horizontalPosition?: number; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Specifies if the frame is locked. * * @remarks * [Api set: WordApiDesktop 1.3] */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; - } - /** An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ - interface ColorFormatUpdateData { + lockAnchor?: boolean; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApiDesktop 1.3] */ - brightness?: number; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the theme color for a color format. + * Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApiDesktop 1.3] */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Specifies if document text wraps around the frame. * * @remarks * [Api set: WordApiDesktop 1.3] */ - rgb?: string; + textWrap?: boolean; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - tintAndShade?: number; - } - /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ - interface ShadowFormatUpdateData { - /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + verticalDistanceFromText?: number; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks * [Api set: WordApiDesktop 1.3] */ - blur?: number; + verticalPosition?: number; /** - * Specifies whether the object or the formatting applied to it is visible. + * Specifies the width (in points) of the frame. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isVisible?: boolean; + width?: number; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Specifies the rule used to determine the width of the frame. * * @remarks * [Api set: WordApiDesktop 1.3] */ - obscured?: boolean; + widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + } + /** An interface describing the data returned by calling `frameCollection.toJSON()`. */ + interface FrameCollectionData { + items?: Word.Interfaces.FrameData[]; + } + /** An interface describing the data returned by calling `documentLibraryVersion.toJSON()`. */ + interface DocumentLibraryVersionData { /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Gets any optional comments associated with this version of the shared document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - offsetX?: number; + comments?: string; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks * [Api set: WordApiDesktop 1.3] */ - offsetY?: number; + modified?: any; /** - * Specifies whether to rotate the shadow when rotating the shape. + * Gets the name of the user who last saved this version of the shared document to the server. * * @remarks * [Api set: WordApiDesktop 1.3] */ - rotateWithShape?: boolean; + modifiedBy?: string; + } + /** An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`. */ + interface DocumentLibraryVersionCollectionData { + items?: Word.Interfaces.DocumentLibraryVersionData[]; + } + /** An interface describing the data returned by calling `dropCap.toJSON()`. */ + interface DropCapData { /** - * Specifies the width of the shadow. + * Gets the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - size?: number; + distanceFromText?: number; /** - * Specifies the type of shadow formatting to apply to a shape. + * Gets the name of the font for the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + fontName?: string; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the height (in lines) of the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - transparency?: number; + linesToDrop?: number; /** - * Specifies the shape shadow type. + * Gets the position of the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + position?: Word.DropPosition | "None" | "Normal" | "Margin"; } - /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ - interface ThreeDimensionalFormatUpdateData { + /** An interface describing the data returned by calling `listFormat.toJSON()`. */ + interface ListFormatData { /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - contourColor?: Word.Interfaces.ColorFormatUpdateData; + list?: Word.Interfaces.ListData; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Gets the list template associated with the `ListFormat` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - extrusionColor?: Word.Interfaces.ColorFormatUpdateData; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * Specifies the depth of the bottom bevel. + * Indicates whether the `ListFormat` object contains a single list. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bevelBottomDepth?: number; + isSingleList?: boolean; /** - * Specifies the inset size for the bottom bevel. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bevelBottomInset?: number; + isSingleListTemplate?: boolean; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + listLevelNumber?: number; /** - * Specifies the depth of the top bevel. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bevelTopDepth?: number; + listString?: string; /** - * Specifies the inset size for the top bevel. + * Gets the type of the list for the `ListFormat` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bevelTopInset?: number; + listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + listValue?: number; + } + /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ + interface FillFormatData { /** - * Specifies the width of the contour of a shape. + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + backgroundColor?: Word.Interfaces.ColorFormatData; + /** + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + foregroundColor?: Word.Interfaces.ColorFormatData; + /** + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApiDesktop 1.3] */ - contourWidth?: number; + gradientAngle?: number; /** - * Specifies the depth of the shape's extrusion. + * Gets the gradient color type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - depth?: number; + gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. * * @remarks * [Api set: WordApiDesktop 1.3] */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + gradientDegree?: number; /** - * Specifies the amount of perspective for a shape. + * Returns the gradient style for the fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - fieldOfView?: number; + gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isPerspective?: boolean; + gradientVariant?: number; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApiDesktop 1.3] */ isVisible?: boolean; /** - * Specifies the angle of the lighting. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lightAngle?: number; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Returns the preset gradient type for the fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; /** - * Specifies the position of the light source relative to the extrusion. + * Gets the preset texture. * * @remarks * [Api set: WordApiDesktop 1.3] */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; /** - * Specifies the intensity of the extrusion lighting. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + rotateWithObject?: boolean; /** - * Specifies the extrusion surface material. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - projectText?: boolean; + textureHorizontalScale?: number; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Returns the name of the custom texture file for the fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - rotationX?: number; + textureName?: string; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - rotationY?: number; + textureOffsetX?: number; /** - * Specifies the z-axis rotation of the camera. + * Specifies the vertical offset of the texture. * * @remarks * [Api set: WordApiDesktop 1.3] */ - rotationZ?: number; + textureOffsetY?: number; /** - * Specifies the position on the z-axis for the shape. + * Specifies whether the texture is tiled. * * @remarks * [Api set: WordApiDesktop 1.3] */ - z?: number; - } - /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ - interface BibliographyUpdateData { + textureTile?: boolean; /** - * Specifies the name of the active style to use for the bibliography. + * Returns the texture type for the fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bibliographyStyle?: string; - } - /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ - interface SourceCollectionUpdateData { - items?: Word.Interfaces.SourceData[]; - } - /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ - interface PageSetupUpdateData { - /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - lineNumbering?: Word.Interfaces.LineNumberingUpdateData; + textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Specifies whether Microsoft Word prints the document as a booklet. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bookFoldPrinting?: boolean; + textureVerticalScale?: number; /** - * Specifies the number of pages for each booklet. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApiDesktop 1.3] */ - bookFoldPrintingSheets?: number; + transparency?: number; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * Gets the fill format type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bookFoldReversePrinting?: boolean; + type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + } + /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ + interface GlowFormatData { /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + color?: Word.Interfaces.ColorFormatData; + /** + * Specifies the length of the radius for a glow effect. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bottomMargin?: number; + radius?: number; /** - * Specifies the number of characters per line in the document grid. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApiDesktop 1.3] */ - charsLine?: number; + transparency?: number; + } + /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ + interface LineFormatData { /** - * Specifies whether the first page has a different header and footer. + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + backgroundColor?: Word.Interfaces.ColorFormatData; + /** + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + foregroundColor?: Word.Interfaces.ColorFormatData; + /** + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - differentFirstPageHeaderFooter?: boolean; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the distance between the footer and the bottom of the page in points. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - footerDistance?: number; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gutter?: number; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies on which side the gutter appears in a document. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the distance between the header and the top of the page in points. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - headerDistance?: number; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies the layout mode for the current document. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - leftMargin?: number; + insetPen?: boolean; /** - * Specifies the number of lines per page in the document grid. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApiDesktop 1.3] */ - linesPage?: number; + isVisible?: boolean; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - mirrorMargins?: boolean; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies whether odd and even pages have different headers and footers. + * Specifies the line format style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - oddAndEvenPagesHeaderFooter?: boolean; + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Specifies the orientation of the page. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApiDesktop 1.3] */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + transparency?: number; /** - * Specifies the page height in points. + * Specifies the thickness of the line in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - pageHeight?: number; + weight?: number; + } + /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ + interface ReflectionFormatData { /** - * Specifies the page width in points. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApiDesktop 1.3] */ - pageWidth?: number; + blur?: number; /** - * Specifies the paper size of the page. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + offset?: number; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApiDesktop 1.3] */ - rightMargin?: number; + size?: number; /** - * Specifies the reading order and alignment for the specified sections. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApiDesktop 1.3] */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + transparency?: number; /** - * Specifies the type of section break for the specified object. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + } + /** An interface describing the data returned by calling `colorFormat.toJSON()`. */ + interface ColorFormatData { /** - * Specifies whether to show the grid. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApiDesktop 1.3] */ - showGrid?: boolean; + brightness?: number; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - suppressEndnotes?: boolean; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Specifies the top margin of the page in points. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - topMargin?: number; + rgb?: string; /** - * Specifies whether to print two pages per sheet. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApiDesktop 1.3] */ - twoPagesOnOne?: boolean; + tintAndShade?: number; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Returns the shape color type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + type?: Word.ColorType | "rgb" | "scheme"; } - /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ - interface LineNumberingUpdateData { + /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ + interface ShadowFormatData { /** - * Specifies the numeric increment for line numbers. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - countBy?: number; + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApiDesktop 1.3] */ - distanceFromText?: number; + blur?: number; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isActive?: boolean; + isVisible?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + obscured?: boolean; /** - * Specifies the starting line number. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. * * @remarks * [Api set: WordApiDesktop 1.3] */ - startingNumber?: number; - } - /** An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`. */ - interface TextColumnCollectionUpdateData { - items?: Word.Interfaces.TextColumnData[]; - } - /** An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`. */ - interface TextColumnUpdateData { + offsetX?: number; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks * [Api set: WordApiDesktop 1.3] */ - spaceAfter?: number; + offsetY?: number; /** - * Specifies the width, in points, of the specified text columns. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - width?: number; - } - /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ - interface CritiqueAnnotationData { - /** - * Gets the critique that was passed when the annotation was inserted. - * - * @remarks - * [Api set: WordApi 1.7] - */ - critique?: Word.Critique; - } - /** An interface describing the data returned by calling `annotation.toJSON()`. */ - interface AnnotationData { + rotateWithShape?: boolean; /** - * Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. + * Specifies the width of the shadow. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.3] */ - id?: string; + size?: number; /** - * Gets the state of the annotation. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.3] */ - state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; - } - /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ - interface AnnotationCollectionData { - items?: Word.Interfaces.AnnotationData[]; - } - /** An interface describing the data returned by calling `application.toJSON()`. */ - interface ApplicationData { - /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - bibliography?: Word.Interfaces.BibliographyData; + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApiDesktop 1.3] */ - checkLanguage?: boolean; + transparency?: number; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - language?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; } - /** An interface describing the data returned by calling `body.toJSON()`. */ - interface BodyData { - /** - * Gets the collection of rich text content control objects in the body. - * - * @remarks - * [Api set: WordApi 1.1] - */ - contentControls?: Word.Interfaces.ContentControlData[]; - /** - * Gets the collection of `Field` objects in the body. - * - * @remarks - * [Api set: WordApi 1.4] - */ - fields?: Word.Interfaces.FieldData[]; - /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontData; - /** - * Gets the collection of `InlinePicture` objects in the body. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; - /** - * Gets the collection of `List` objects in the body. - * - * @remarks - * [Api set: WordApi 1.3] - */ - lists?: Word.Interfaces.ListData[]; - /** - * Gets the collection of `Paragraph` objects in the body. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. - */ - paragraphs?: Word.Interfaces.ParagraphData[]; + /** An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`. */ + interface ThreeDimensionalFormatData { /** - * Gets the collection of `Shape` objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + * [Api set: WordApiDesktop 1.3] */ - shapes?: Word.Interfaces.ShapeData[]; + contourColor?: Word.Interfaces.ColorFormatData; /** - * Gets the collection of `Table` objects in the body. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - tables?: Word.Interfaces.TableData[]; + extrusionColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies the depth of the bottom bevel. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - style?: string; + bevelBottomDepth?: number; /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the inset size for the bottom bevel. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + bevelBottomInset?: number; /** - * Gets the text of the body. Use the insertText method to insert text. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - text?: string; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Gets the type of the body. The type can be `mainDoc`, `section`, `header`, `footer`, or `tableCell`. Additional types `footnote`, `endnote`, and `noteItem` are supported in WordApi 1.5 and later. + * Specifies the depth of the top bevel. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem"; - } - /** An interface describing the data returned by calling `border.toJSON()`. */ - interface BorderData { + bevelTopDepth?: number; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the inset size for the top bevel. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - color?: string; + bevelTopInset?: number; /** - * Gets the location of the border. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Specifies the border type for the border. + * Specifies the width of the contour of a shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + contourWidth?: number; /** - * Specifies whether the border is visible. + * Specifies the depth of the shape's extrusion. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - visible?: boolean; + depth?: number; /** - * Specifies the width for the border. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - } - /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ - interface BorderUniversalData { + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Specifies the graphical page-border design for the document. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + fieldOfView?: number; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks * [Api set: WordApiDesktop 1.3] */ - artWidth?: number; + isPerspective?: boolean; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApiDesktop 1.3] */ - color?: string; + isVisible?: boolean; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies the angle of the lighting. * * @remarks * [Api set: WordApiDesktop 1.3] */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + lightAngle?: number; /** - * Returns `true` if an inside border can be applied to the specified object. + * Returns a `PresetCamera` value that represents the camera presets. * * @remarks * [Api set: WordApiDesktop 1.3] */ - inside?: boolean; + presetCamera?: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; /** - * Specifies whether the border is visible. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). * * @remarks * [Api set: WordApiDesktop 1.3] */ - isVisible?: boolean; + presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Specifies the line style of the border. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Specifies the line width of an object's border. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; - } - /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ - interface BorderCollectionData { - items?: Word.Interfaces.BorderData[]; - } - /** An interface describing the data returned by calling `borderUniversalCollection.toJSON()`. */ - interface BorderUniversalCollectionData { - items?: Word.Interfaces.BorderUniversalData[]; - } - /** An interface describing the data returned by calling `break.toJSON()`. */ - interface BreakData { - /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeData; + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Returns the page number on which the break occurs. + * Specifies the intensity of the extrusion lighting. * * @remarks * [Api set: WordApiDesktop 1.3] */ - pageIndex?: number; - } - /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ - interface BreakCollectionData { - items?: Word.Interfaces.BreakData[]; - } - /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ - interface BuildingBlockData { + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Specifies the description for the building block. + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApiDesktop 1.3] */ - description?: string; + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Returns the internal identification number for the building block. + * Returns the preset extrusion format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - id?: string; + presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; /** - * Returns the position of this building block in a collection. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - index?: number; + projectText?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApiDesktop 1.3] */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + rotationX?: number; /** - * Specifies the name of the building block. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApiDesktop 1.3] */ - name?: string; + rotationY?: number; /** - * Specifies the contents of the building block. + * Specifies the z-axis rotation of the camera. * * @remarks * [Api set: WordApiDesktop 1.3] */ - value?: string; - } - /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ - interface BuildingBlockCategoryData { + rotationZ?: number; /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * Specifies the position on the z-axis for the shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - index?: number; + z?: number; + } + /** An interface describing the data returned by calling `bibliography.toJSON()`. */ + interface BibliographyData { /** - * Returns the name of the `BuildingBlockCategory` object. + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + sources?: Word.Interfaces.SourceData[]; + /** + * Specifies the name of the active style to use for the bibliography. * * @remarks * [Api set: WordApiDesktop 1.3] */ - name?: string; + bibliographyStyle?: string; } - /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ - interface BuildingBlockTypeItemData { + /** An interface describing the data returned by calling `sourceCollection.toJSON()`. */ + interface SourceCollectionData { + items?: Word.Interfaces.SourceData[]; + } + /** An interface describing the data returned by calling `source.toJSON()`. */ + interface SourceData { /** - * Returns the position of an item in a collection. + * Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - index?: number; + isCited?: boolean; /** - * Returns the localized name of a building block type. + * Gets the tag of the source. * * @remarks * [Api set: WordApiDesktop 1.3] */ - name?: string; - } - /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ - interface CheckboxContentControlData { + tag?: string; /** - * Specifies the current state of the checkbox. + * Gets the XML representation of the source. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.3] */ - isChecked?: boolean; + xml?: string; } - /** An interface describing the data returned by calling `comment.toJSON()`. */ - interface CommentData { + /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ + interface PageSetupData { /** - * Specifies the comment's content range. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - contentRange?: Word.Interfaces.CommentContentRangeData; + lineNumbering?: Word.Interfaces.LineNumberingData; /** - * Gets the collection of reply objects associated with the comment. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - replies?: Word.Interfaces.CommentReplyData[]; - /** - * Gets the email of the comment's author. - * - * @remarks - * [Api set: WordApi 1.4] - */ - authorEmail?: string; - /** - * Gets the name of the comment's author. - * - * @remarks - * [Api set: WordApi 1.4] - */ - authorName?: string; - /** - * Specifies the comment's content as plain text. - * - * @remarks - * [Api set: WordApi 1.4] - */ - content?: string; - /** - * Gets the creation date of the comment. - * - * @remarks - * [Api set: WordApi 1.4] - */ - creationDate?: Date; + textColumns?: Word.Interfaces.TextColumnData[]; /** - * Gets the ID of the comment. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - id?: string; + bookFoldPrinting?: boolean; /** - * Specifies the comment thread's status. Setting to `true` resolves the comment thread. Getting a value of `true` means that the comment thread is resolved. + * Specifies the number of pages for each booklet. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - resolved?: boolean; - } - /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ - interface CommentCollectionData { - items?: Word.Interfaces.CommentData[]; - } - /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ - interface CommentContentRangeData { + bookFoldPrintingSheets?: number; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - bold?: boolean; + bookFoldReversePrinting?: boolean; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - hyperlink?: string; + bottomMargin?: number; /** - * Checks whether the range length is zero. + * Specifies the number of characters per line in the document grid. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - isEmpty?: boolean; + charsLine?: number; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies whether the first page has a different header and footer. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - italic?: boolean; + differentFirstPageHeaderFooter?: boolean; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - strikeThrough?: boolean; + footerDistance?: number; /** - * Gets the text of the comment range. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - text?: string; + gutter?: number; /** - * Specifies a value that indicates the comment text's underline type. `none` if the comment text isn't underlined. + * Specifies on which side the gutter appears in a document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; - } - /** An interface describing the data returned by calling `commentReply.toJSON()`. */ - interface CommentReplyData { - /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeData; - /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentComment?: Word.Interfaces.CommentData; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Gets the email of the comment reply's author. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - authorEmail?: string; + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Gets the name of the comment reply's author. + * Specifies the distance between the header and the top of the page in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - authorName?: string; + headerDistance?: number; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies the layout mode for the current document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - content?: string; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Gets the creation date of the comment reply. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - creationDate?: Date; + leftMargin?: number; /** - * Gets the ID of the comment reply. + * Specifies the number of lines per page in the document grid. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - id?: string; - } - /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ - interface CommentReplyCollectionData { - items?: Word.Interfaces.CommentReplyData[]; - } - /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ - interface XmlMappingData { - /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - customXmlNode?: Word.Interfaces.CustomXmlNodeData; - /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - customXmlPart?: Word.Interfaces.CustomXmlPartData; + linesPage?: number; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isMapped?: boolean; + mirrorMargins?: boolean; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApiDesktop 1.3] */ - prefixMappings?: string; + oddAndEvenPagesHeaderFooter?: boolean; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xpath?: string; - } - /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ - interface CustomXmlPrefixMappingCollectionData { - items?: Word.Interfaces.CustomXmlPrefixMappingData[]; - } - /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ - interface CustomXmlPrefixMappingData { + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Specifies the page height in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - namespaceUri?: string; + pageHeight?: number; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Specifies the page width in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - prefix?: string; - } - /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ - interface CustomXmlSchemaData { + pageWidth?: number; /** - * Gets the location of the schema on a computer. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApiDesktop 1.3] */ - location?: string; + paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - namespaceUri?: string; - } - /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ - interface CustomXmlSchemaCollectionData { - items?: Word.Interfaces.CustomXmlSchemaData[]; - } - /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ - interface CustomXmlNodeCollectionData { - items?: Word.Interfaces.CustomXmlNodeData[]; - } - /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ - interface CustomXmlNodeData { - /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - attributes?: Word.Interfaces.CustomXmlNodeData[]; - /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - childNodes?: Word.Interfaces.CustomXmlNodeData[]; - /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - firstChild?: Word.Interfaces.CustomXmlNodeData; - /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - lastChild?: Word.Interfaces.CustomXmlNodeData; - /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - nextSibling?: Word.Interfaces.CustomXmlNodeData; - /** - * Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - ownerPart?: Word.Interfaces.CustomXmlPartData; - /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - parentNode?: Word.Interfaces.CustomXmlNodeData; - /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - previousSibling?: Word.Interfaces.CustomXmlNodeData; + rightMargin?: number; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApiDesktop 1.3] */ - baseName?: string; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Gets the unique address identifier for the namespace of the node. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - namespaceUri?: string; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Gets the type of the current node. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + showGrid?: boolean; /** - * Specifies the value of the current node. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nodeValue?: string; + suppressEndnotes?: boolean; /** - * Specifies the text for the current node. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - text?: string; + topMargin?: number; /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xpath?: string; + twoPagesOnOne?: boolean; /** - * Gets the XML representation of the current node and its children. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xml?: string; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; } - /** An interface describing the data returned by calling `contentControl.toJSON()`. */ - interface ContentControlData { - /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; - /** - * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; - /** - * Gets the data of the content control when its type is `comboBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.9] - */ - comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; - /** - * Gets the collection of `ContentControl` objects in the content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ - contentControls?: Word.Interfaces.ContentControlData[]; - /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; - /** - * Gets the data of the content control when its type is `dropDownList`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.9] - */ - dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; - /** - * Gets the collection of `Field` objects in the content control. - * - * @remarks - * [Api set: WordApi 1.4] - */ - fields?: Word.Interfaces.FieldData[]; - /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontData; - /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - groupContentControl?: Word.Interfaces.GroupContentControlData; - /** - * Gets the collection of `InlinePicture` objects in the content control. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ + interface LineNumberingData { /** - * Gets the collection of `List` objects in the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ - lists?: Word.Interfaces.ListData[]; + * Specifies the numeric increment for line numbers. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + countBy?: number; /** - * Gets the collection of `Paragraph` objects in the content control. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. - */ - paragraphs?: Word.Interfaces.ParagraphData[]; + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + distanceFromText?: number; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pictureContentControl?: Word.Interfaces.PictureContentControlData; + * Specifies if line numbering is active for the specified document, section, or sections. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isActive?: boolean; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Gets the collection of `Table` objects in the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ - tables?: Word.Interfaces.TableData[]; + * Specifies the starting line number. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + startingNumber?: number; + } + /** An interface describing the data returned by calling `textColumnCollection.toJSON()`. */ + interface TextColumnCollectionData { + items?: Word.Interfaces.TextColumnData[]; + } + /** An interface describing the data returned by calling `textColumn.toJSON()`. */ + interface TextColumnData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - xmlMapping?: Word.Interfaces.XmlMappingData; + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + spaceAfter?: number; /** - * Specifies the appearance of the content control. The value can be `boundingBox`, `tags`, or `hidden`. + * Specifies the width, in points, of the specified text columns. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + width?: number; + } + /** An interface describing the data returned by calling `selection.toJSON()`. */ + interface SelectionData { /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. + * Specifies the ending character position of the selection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - cannotDelete?: boolean; + end?: number; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies the width in which Word fits the text in the current selection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - cannotEdit?: boolean; + fitTextWidth?: number; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - color?: string; + hasNoProofing?: boolean; /** - * Gets an integer that represents the content control identifier. + * Returns whether the selection in the specified window or pane is active. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - id?: number; + isActive?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies whether column selection mode is active. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - placeholderText?: string; + isColumnSelectModeActive?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. + * Returns whether the selection is at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - removeWhenEdited?: boolean; + isEndOfRowMark?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the `styleBuiltIn` property. + * Specifies whether Extend mode is active. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - style?: string; + isExtendModeActive?: boolean; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the `style` property. + * Returns whether the insertion point is at the end of a line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + isInsertionPointAtEndOfLine?: boolean; /** - * Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. + * Specifies whether the beginning of the selection is active. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + isStartActive?: boolean; /** - * Specifies a tag to identify a content control. + * Specifies whether Word has detected the language of the selected text. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - tag?: string; + languageDetected?: boolean; /** - * Gets the text of the content control. + * Returns the language for the selection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - text?: string; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the title for a content control. + * Returns the East Asian language for the selection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - title?: string; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. + * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; - } - /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ - interface ContentControlCollectionData { - items?: Word.Interfaces.ContentControlData[]; - } - /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ - interface ContentControlListItemData { + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies the orientation of text in the selection. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.4] */ - displayText?: string; + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** - * Specifies the index location of a content control list item in the collection of list items. + * Specifies the starting character position of the selection. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.4] */ - index?: number; + start?: number; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Returns the number of characters in the story that contains the selection. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.4] */ - value?: string; - } - /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ - interface ContentControlListItemCollectionData { - items?: Word.Interfaces.ContentControlListItemData[]; - } - /** An interface describing the data returned by calling `customProperty.toJSON()`. */ - interface CustomPropertyData { + storyLength?: number; /** - * Gets the key of the custom property. + * Returns the story type for the selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - key?: string; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies the text in the selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; + text?: string; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Returns the selection type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - value?: any; + type?: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; } - /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ - interface CustomPropertyCollectionData { - items?: Word.Interfaces.CustomPropertyData[]; + /** An interface describing the data returned by calling `rangeScopedCollection.toJSON()`. */ + interface RangeScopedCollectionData { + items?: Word.Interfaces.RangeData[]; } - /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ - interface CustomXmlPartData { + /** An interface describing the data returned by calling `bookmark.toJSON()`. */ + interface BookmarkData { /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - documentElement?: Word.Interfaces.CustomXmlNodeData; + range?: Word.Interfaces.RangeData; /** - * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; + * Specifies the ending character position of the bookmark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + end?: number; /** - * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; + * Returns `true` if the bookmark is a table column. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isColumn?: boolean; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Returns `true` if the bookmark is empty. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - builtIn?: boolean; + isEmpty?: boolean; /** - * Gets the ID of the custom XML part. + * Returns the name of the `Bookmark` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - id?: string; + name?: string; /** - * Gets the namespace URI of the custom XML part. + * Specifies the starting character position of the bookmark. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - namespaceUri?: string; + start?: number; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Returns the story type for the bookmark. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - xml?: string; - } - /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ - interface CustomXmlPartCollectionData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ - interface CustomXmlPartScopedCollectionData { - items?: Word.Interfaces.CustomXmlPartData[]; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; } - /** An interface describing the data returned by calling `document.toJSON()`. */ - interface DocumentData { - /** - * Gets the active window for the document. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - activeWindow?: Word.Interfaces.WindowData; - /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - bibliography?: Word.Interfaces.BibliographyData; - /** - * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ - body?: Word.Interfaces.BodyData; - /** - * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ - contentControls?: Word.Interfaces.ContentControlData[]; - /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; - /** - * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; - /** - * Returns a `FrameCollection` object that represents all the frames in the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - frames?: Word.Interfaces.FrameData[]; - /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; - /** - * Returns a `PageSetup` object that's associated with the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pageSetup?: Word.Interfaces.PageSetupData; - /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - properties?: Word.Interfaces.DocumentPropertiesData; - /** - * Gets the collection of `Section` objects in the document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - sections?: Word.Interfaces.SectionData[]; - /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - settings?: Word.Interfaces.SettingData[]; + /** An interface describing the data returned by calling `bookmarkCollection.toJSON()`. */ + interface BookmarkCollectionData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface describing the data returned by calling `index.toJSON()`. */ + interface IndexData { /** - * Gets the collection of `Word.Window` objects for the document. + * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - windows?: Word.Interfaces.WindowData[]; + range?: Word.Interfaces.RangeData; /** - * Specifies if automatic hyphenation is turned on for the document. + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - autoHyphenation?: boolean; + filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; /** - * Specifies if the edits in the document are automatically saved. + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - autoSaveOn?: boolean; + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; /** - * Specifies the ChangeTracking mode. + * Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Gets the number of columns for each page of the index. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - consecutiveHyphensLimit?: number; + numberOfColumns?: number; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies if page numbers are aligned with the right margin in the index. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - hyphenateCaps?: boolean; + rightAlignPageNumbers?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageDetected?: boolean; + separateAccentedLetterHeadings?: boolean; /** - * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. + * Specifies the sorting criteria for the index. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - saved?: boolean; + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * Specifies the leader character between entries in the index and their associated page numbers. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + /** + * Gets the index type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: Word.IndexType | "Indent" | "Runin"; } - /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ - interface DocumentCreatedData { + /** An interface describing the data returned by calling `indexCollection.toJSON()`. */ + interface IndexCollectionData { + items?: Word.Interfaces.IndexData[]; + } + /** An interface describing the data returned by calling `listTemplateCollection.toJSON()`. */ + interface ListTemplateCollectionData { + items?: Word.Interfaces.ListTemplateData[]; + } + /** An interface describing the data returned by calling `listTemplateGallery.toJSON()`. */ + interface ListTemplateGalleryData { + } + /** An interface describing the data returned by calling `listTemplateGalleryCollection.toJSON()`. */ + interface ListTemplateGalleryCollectionData { + items?: Word.Interfaces.ListTemplateGalleryData[]; + } + /** + * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface EditorLoadOptions { /** - * Gets the `Body` object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - body?: Word.Interfaces.BodyData; + 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; /** - * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Gets a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApiDesktop 1.4] */ - contentControls?: Word.Interfaces.ContentControlData[]; + nextRange?: Word.Interfaces.RangeLoadOptions; /** - * Gets the custom XML parts in the document. + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] + * [Api set: WordApiDesktop 1.4] */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the properties of the document. + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + id?: boolean; + /** + * Gets the name of the editor. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + name?: boolean; + } + /** + * Represents the coauthoring conflicts in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface ConflictCollectionLoadOptions { + /** + 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; + /** + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApiDesktop 1.4] */ - properties?: Word.Interfaces.DocumentPropertiesData; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the collection of `Section` objects in the document. + * For EACH ITEM in the collection: Gets the `RevisionType` for the `Conflict` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: boolean; + } + /** + * Represents a coauthoring conflict in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface ConflictLoadOptions { + /** + 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; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApiDesktop 1.4] */ - sections?: Word.Interfaces.SectionData[]; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the add-in's settings in the document. + * Gets the `RevisionType` for the `Conflict` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: boolean; + } + /** + * Represents an annotation wrapper around critique displayed in the document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface CritiqueAnnotationLoadOptions { + /** + 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; + /** + * Gets the range of text that is annotated. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] + * [Api set: WordApi 1.7] */ - settings?: Word.Interfaces.SettingData[]; + range?: Word.Interfaces.RangeLoadOptions; /** - * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.7] */ - saved?: boolean; + critique?: boolean; } - /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ - interface DocumentPropertiesData { + /** + * Represents an annotation attached to a paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface AnnotationLoadOptions { /** - * Gets the collection of custom properties of the document. + 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; + /** + * Gets the `CritiqueAnnotation` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - customProperties?: Word.Interfaces.CustomPropertyData[]; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Gets the application name of the document. + * Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - applicationName?: string; + id?: boolean; /** - * Specifies the author of the document. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - author?: string; + state?: boolean; + } + /** + * Contains a collection of {@link Word.Annotation} objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface AnnotationCollectionLoadOptions { /** - * Specifies the category of the document. - * - * @remarks - * [Api set: WordApi 1.3] + 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`). */ - category?: string; + $all?: boolean; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * For EACH ITEM in the collection: Gets the `CritiqueAnnotation` object. + * + * @remarks + * [Api set: WordApi 1.7] + */ + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + /** + * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - comments?: string; + id?: boolean; /** - * Specifies the company of the document. + * For EACH ITEM in the collection: Gets the state of the annotation. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - company?: string; + state?: boolean; + } + /** + * Represents the `Application` object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ApplicationLoadOptions { /** - * Gets the creation date of the document. - * - * @remarks - * [Api set: WordApi 1.3] + 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`). */ - creationDate?: Date; + $all?: boolean; /** - * Specifies the format of the document. + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bibliography?: Word.Interfaces.BibliographyLoadOptions; + /** + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - format?: string; + checkLanguage?: boolean; /** - * Specifies the keywords of the document. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - keywords?: string; + language?: boolean; + } + /** + * Represents the body of a document or a section. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface BodyLoadOptions { /** - * Gets the last author of the document. + 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; + /** + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontLoadOptions; + /** + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentBody?: Word.Interfaces.BodyLoadOptions; + /** + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; + /** + * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + /** + * Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + /** + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentSection?: Word.Interfaces.SectionLoadOptions; + /** + * Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; + /** + * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lastAuthor?: string; + style?: boolean; /** - * Gets the last print date of the document. + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ - lastPrintDate?: Date; + styleBuiltIn?: boolean; /** - * Gets the last save time of the document. + * Gets the text of the body. Use the insertText method to insert text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lastSaveTime?: Date; + text?: boolean; /** - * Specifies the manager of the document. + * Gets the type of the body. The type can be `mainDoc`, `section`, `header`, `footer`, or `tableCell`. Additional types `footnote`, `endnote`, and `noteItem` are supported in WordApi 1.5 and later. * * @remarks * [Api set: WordApi 1.3] */ - manager?: string; + type?: boolean; + } + /** + * Represents the `Border` object for text, a paragraph, or a table. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface BorderLoadOptions { /** - * Gets the revision number of the document. + 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; + /** + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - revisionNumber?: string; + color?: boolean; /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * Gets the location of the border. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - security?: number; + location?: boolean; /** - * Specifies the subject of the document. + * Specifies the border type for the border. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - subject?: string; + type?: boolean; /** - * Gets the template of the document. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - template?: string; + visible?: boolean; /** - * Specifies the title of the document. + * Specifies the width for the border. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - title?: string; - } - /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ - interface DropDownListContentControlData { - } - /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ - interface ComboBoxContentControlData { + width?: boolean; } - /** An interface describing the data returned by calling `field.toJSON()`. */ - interface FieldData { + /** + * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface BorderUniversalLoadOptions { /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ - result?: Word.Interfaces.RangeData; + 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; /** - * Specifies the field's code instruction. + * Specifies the graphical page-border design for the document. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApiDesktop 1.3] */ - code?: string; + artStyle?: boolean; /** - * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - data?: string; + artWidth?: boolean; /** - * Gets the field's kind. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + color?: boolean; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - locked?: boolean; + colorIndex?: boolean; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Returns `true` if an inside border can be applied to the specified object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - showCodes?: boolean; + inside?: boolean; /** - * Gets the field's type. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; - } - /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ - interface FieldCollectionData { - items?: Word.Interfaces.FieldData[]; - } - /** An interface describing the data returned by calling `font.toJSON()`. */ - interface FontData { - /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - borders?: Word.Interfaces.BorderUniversalData[]; - /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - fill?: Word.Interfaces.FillFormatData; - /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - glow?: Word.Interfaces.GlowFormatData; - /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - line?: Word.Interfaces.LineFormatData; - /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - reflection?: Word.Interfaces.ReflectionFormatData; - /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - textColor?: Word.Interfaces.ColorFormatData; - /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - textShadow?: Word.Interfaces.ShadowFormatData; - /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; + isVisible?: boolean; /** - * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * Specifies the line style of the border. * * @remarks * [Api set: WordApiDesktop 1.3] */ - allCaps?: boolean; + lineStyle?: boolean; /** - * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. + * Specifies the line width of an object's border. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - bold?: boolean; + lineWidth?: boolean; + } + /** + * Represents the collection of border styles. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface BorderCollectionLoadOptions { /** - * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. + 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; + /** + * For EACH ITEM in the collection: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - boldBidirectional?: boolean; + color?: boolean; /** - * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. + * For EACH ITEM in the collection: Gets the location of the border. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - color?: string; + location?: boolean; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * For EACH ITEM in the collection: Specifies the border type for the border. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + type?: boolean; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + visible?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * For EACH ITEM in the collection: Specifies the width for the border. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - contextualAlternates?: boolean; + width?: boolean; + } + /** + * Represents the collection of {@link Word.BorderUniversal} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface BorderUniversalCollectionLoadOptions { /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + 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; + /** + * For EACH ITEM in the collection: Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - diacriticColor?: string; + artStyle?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApiDesktop 1.3] */ - disableCharacterSpaceGrid?: boolean; + artWidth?: boolean; /** - * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - doubleStrikeThrough?: boolean; + color?: boolean; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - emboss?: boolean; + colorIndex?: boolean; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + inside?: boolean; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks * [Api set: WordApiDesktop 1.3] */ - engrave?: boolean; + isVisible?: boolean; /** - * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. + * For EACH ITEM in the collection: Specifies the line style of the border. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - hidden?: boolean; + lineStyle?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to `null`. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * For EACH ITEM in the collection: Specifies the line width of an object's border. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - highlightColor?: string; + lineWidth?: boolean; + } + /** + * Represents a break in a Word document. This could be a page, column, or section break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface BreakLoadOptions { /** - * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. - * - * @remarks - * [Api set: WordApi 1.1] + 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`). */ - italic?: boolean; + $all?: boolean; /** - * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApiDesktop 1.3] */ - italicBidirectional?: boolean; + pageIndex?: boolean; + } + /** + * Contains a collection of {@link Word.Break} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface BreakCollectionLoadOptions { /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - kerning?: number; + $all?: boolean; /** - * Specifies the ligature setting for the `Font` object. + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the page number on which the break occurs. * * @remarks * [Api set: WordApiDesktop 1.3] */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + pageIndex?: boolean; + } + /** + * Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface BuildingBlockLoadOptions { /** - * Specifies the name of the font. + 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; + /** + * Returns a `BuildingBlockCategory` object that represents the category for the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; + /** + * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + /** + * Specifies the description for the building block. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - name?: string; + description?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Returns the internal identification number for the building block. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nameAscii?: string; + id?: boolean; /** - * Specifies the font name in a right-to-left language document. + * Returns the position of this building block in a collection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nameBidirectional?: string; + index?: boolean; /** - * Specifies the East Asian font name. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nameFarEast?: string; + insertType?: boolean; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies the name of the building block. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nameOther?: string; + name?: boolean; /** - * Specifies the number form setting for an OpenType font. + * Specifies the contents of the building block. * * @remarks * [Api set: WordApiDesktop 1.3] */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + value?: boolean; + } + /** + * Represents a category of building blocks in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface BuildingBlockCategoryLoadOptions { /** - * Specifies the number spacing setting for the font. + 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; + /** + * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + /** + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + index?: boolean; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - outline?: boolean; + name?: boolean; + } + /** + * Represents a type of building block in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface BuildingBlockTypeItemLoadOptions { /** - * Specifies the position of text (in points) relative to the base line. + 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; + /** + * Returns the position of an item in a collection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - position?: number; + index?: boolean; /** - * Specifies the scaling percentage applied to the font. + * Returns the localized name of a building block type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - scaling?: number; + name?: boolean; + } + /** + * The data specific to content controls of type CheckBox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface CheckboxContentControlLoadOptions { /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + 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; + /** + * Specifies the current state of the checkbox. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.7] */ - shadow?: boolean; + isChecked?: boolean; + } + /** + * Represents a coauthoring lock in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface CoauthoringLockLoadOptions { /** - * Specifies the font size in points. + 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; + /** + * Gets the owner of the lock. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + owner?: Word.Interfaces.CoauthorLoadOptions; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - size?: number; + type?: boolean; + } + /** + * Represents a collection of coauthoring locks in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface CoauthoringLockCollectionLoadOptions { /** - * Specifies the font size in points for right-to-left text. + 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; + /** + * For EACH ITEM in the collection: Gets the owner of the lock. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + owner?: Word.Interfaces.CoauthorLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sizeBidirectional?: number; + type?: boolean; + } + /** + * Represents a coauthor in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface CoauthorLoadOptions { /** - * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + 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; + /** + * Gets the email address of the coauthor. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - smallCaps?: boolean; + emailAddress?: boolean; /** - * Specifies the spacing between characters. + * Gets the unique identifier for the `Coauthor` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spacing?: number; + id?: boolean; /** - * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. + * Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - strikeThrough?: boolean; + isMe?: boolean; /** - * Specifies the stylistic set for the font. + * Gets the display name of the coauthor. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + name?: boolean; + } + /** + * Contains a collection of {@link Word.Coauthor} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface CoauthorCollectionLoadOptions { /** - * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. + 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; + /** + * For EACH ITEM in the collection: Gets the email address of the coauthor. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - subscript?: boolean; + emailAddress?: boolean; /** - * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. + * For EACH ITEM in the collection: Gets the unique identifier for the `Coauthor` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - superscript?: boolean; + id?: boolean; /** - * Specifies the font's underline type. `none` if the font isn't underlined. + * For EACH ITEM in the collection: Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + isMe?: boolean; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Gets the display name of the coauthor. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - underlineColor?: string; + name?: boolean; } - /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ - interface HyperlinkData { + /** + * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface CoauthoringLoadOptions { /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + 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; + /** + * Gets a `Coauthor` object that represents the current user. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - range?: Word.Interfaces.RangeData; + me?: Word.Interfaces.CoauthorLoadOptions; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Gets whether this document can be coauthored. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - address?: string; + canCoauthor?: boolean; /** - * Specifies the text string for the hyperlink's subject line. + * Gets whether the document can be automatically merged. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - emailSubject?: string; + canMerge?: boolean; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Gets whether the document has pending updates that have not been accepted. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isExtraInfoRequired?: boolean; + pendingUpdates?: boolean; + } + /** + * Represents a coauthoring update in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface CoauthoringUpdateLoadOptions { /** - * Returns the name of the `Hyperlink` object. + 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; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Contains a collection of {@link Word.CoauthoringUpdate} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface CoauthoringUpdateCollectionLoadOptions { + /** + 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; + /** + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Represents a comment in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentLoadOptions { + /** + 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; + /** + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + /** + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - name?: string; + authorEmail?: boolean; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Gets the name of the comment's author. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - screenTip?: string; + authorName?: boolean; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - subAddress?: string; + content?: boolean; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - target?: string; + creationDate?: boolean; /** - * Specifies the hyperlink's visible text in the document. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - textToDisplay?: string; + id?: boolean; /** - * Returns the hyperlink type. + * Specifies the comment thread's status. Setting to `true` resolves the comment thread. Getting a value of `true` means that the comment thread is resolved. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; - } - /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ - interface HyperlinkCollectionData { - items?: Word.Interfaces.HyperlinkData[]; + resolved?: boolean; } - /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ - interface InlinePictureData { + /** + * Contains a collection of {@link Word.Comment} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentCollectionLoadOptions { /** - * Specifies a string that represents the alternative text associated with the inline image. - * - * @remarks - * [Api set: WordApi 1.1] + 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`). */ - altTextDescription?: string; + $all?: boolean; /** - * Specifies a string that contains the title for the inline image. + * For EACH ITEM in the collection: Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + /** + * For EACH ITEM in the collection: Gets the email of the comment's author. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - altTextTitle?: string; + authorEmail?: boolean; /** - * Specifies a number that describes the height of the inline image. + * For EACH ITEM in the collection: Gets the name of the comment's author. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - height?: number; + authorName?: boolean; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * For EACH ITEM in the collection: Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - hyperlink?: string; + content?: boolean; /** - * Gets the format of the inline image. + * For EACH ITEM in the collection: Gets the creation date of the comment. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + creationDate?: boolean; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * For EACH ITEM in the collection: Gets the ID of the comment. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - lockAspectRatio?: boolean; + id?: boolean; /** - * Specifies a number that describes the width of the inline image. + * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to `true` resolves the comment thread. Getting a value of `true` means that the comment thread is resolved. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - width?: number; - } - /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ - interface InlinePictureCollectionData { - items?: Word.Interfaces.InlinePictureData[]; + resolved?: boolean; } - /** An interface describing the data returned by calling `list.toJSON()`. */ - interface ListData { + /** + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentContentRangeLoadOptions { /** - * Gets paragraphs in the list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - paragraphs?: Word.Interfaces.ParagraphData[]; + 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; /** - * Gets the list's ID. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - id?: number; + bold?: boolean; /** - * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - levelExistences?: boolean[]; + hyperlink?: boolean; /** - * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - levelTypes?: Word.ListLevelType[]; - } - /** An interface describing the data returned by calling `listCollection.toJSON()`. */ - interface ListCollectionData { - items?: Word.Interfaces.ListData[]; - } - /** An interface describing the data returned by calling `listItem.toJSON()`. */ - interface ListItemData { + isEmpty?: boolean; /** - * Specifies the level of the item in the list. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - level?: number; + italic?: boolean; /** - * Gets the list item bullet, number, or picture as a string. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - listString?: string; + strikeThrough?: boolean; /** - * Gets the list item order number in relation to its siblings. + * Gets the text of the comment range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - siblingIndex?: number; + text?: boolean; + /** + * Specifies a value that indicates the comment text's underline type. `none` if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: boolean; } - /** An interface describing the data returned by calling `listLevel.toJSON()`. */ - interface ListLevelData { + /** + * Represents a comment reply in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentReplyLoadOptions { /** - * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + 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; + /** + * Specifies the commentReply's content range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - font?: Word.Interfaces.FontData; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentLoadOptions; + /** + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + authorEmail?: boolean; /** - * Specifies the name of the style that's linked to the `ListLevel` object. + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - linkedStyle?: string; + authorName?: boolean; /** - * Specifies the number format for the list level. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - numberFormat?: string; + content?: boolean; /** - * Specifies the position (in points) of the number or bullet for the `ListLevel` object. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - numberPosition?: number; + creationDate?: boolean; /** - * Specifies the number style for the `ListLevel` object. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + id?: boolean; + } + /** + * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentReplyCollectionLoadOptions { /** - * Specifies the list level that must appear before it restarts numbering at 1. + 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; + /** + * For EACH ITEM in the collection: Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + /** + * For EACH ITEM in the collection: Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentLoadOptions; + /** + * For EACH ITEM in the collection: Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - resetOnHigher?: number; + authorEmail?: boolean; /** - * Specifies the starting number for the `ListLevel` object. + * For EACH ITEM in the collection: Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - startAt?: number; + authorName?: boolean; /** - * Specifies the tab position for the `ListLevel` object. + * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - tabPosition?: number; + content?: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. + * For EACH ITEM in the collection: Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - textPosition?: number; + creationDate?: boolean; /** - * Specifies the character inserted after the number for the list level. + * For EACH ITEM in the collection: Gets the ID of the comment reply. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - } - /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ - interface ListLevelCollectionData { - items?: Word.Interfaces.ListLevelData[]; + id?: boolean; } - /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ - interface ListTemplateData { + /** + * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface ConditionalStyleLoadOptions { /** - * Gets a `ListLevelCollection` object that represents all the levels for the list template. + 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; + /** + * Returns a `Font` object that represents the font formatting for the conditional style. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - listLevels?: Word.Interfaces.ListLevelData[]; - /** - * Specifies whether the list template is outline numbered. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - outlineNumbered?: boolean; - } - /** An interface describing the data returned by calling `noteItem.toJSON()`. */ - interface NoteItemData { + font?: Word.Interfaces.FontLoadOptions; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - body?: Word.Interfaces.BodyData; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * Represents a footnote or endnote reference in the main document. + * Returns a `ShadingUniversal` object that represents the shading of the conditional style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - reference?: Word.Interfaces.RangeData; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Represents the note item type: footnote or endnote. + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.NoteItemType | "Footnote" | "Endnote"; - } - /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ - interface NoteItemCollectionData { - items?: Word.Interfaces.NoteItemData[]; - } - /** An interface describing the data returned by calling `page.toJSON()`. */ - interface PageData { - /** - * Gets a `BreakCollection` object that represents the breaks on the page. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - breaks?: Word.Interfaces.BreakData[]; + bottomPadding?: boolean; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - height?: number; + leftPadding?: boolean; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - index?: number; + rightPadding?: boolean; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ - interface PageCollectionData { - items?: Word.Interfaces.PageData[]; + topPadding?: boolean; } - /** An interface describing the data returned by calling `pane.toJSON()`. */ - interface PaneData { - /** - * Gets the collection of pages in the pane. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - pages?: Word.Interfaces.PageData[]; + /** + * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface XmlMappingLoadOptions { /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - pagesEnclosingViewport?: Word.Interfaces.PageData[]; - } - /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ - interface PaneCollectionData { - items?: Word.Interfaces.PaneData[]; - } - /** An interface describing the data returned by calling `window.toJSON()`. */ - interface WindowData { - } - /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ - interface WindowCollectionData { - items?: Word.Interfaces.WindowData[]; - } - /** An interface describing the data returned by calling `paragraph.toJSON()`. */ - interface ParagraphData { + 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; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks * [Api set: WordApiDesktop 1.3] */ - borders?: Word.Interfaces.BorderUniversalData[]; - /** - * Gets the collection of fields in the paragraph. - * - * @remarks - * [Api set: WordApi 1.4] - */ - fields?: Word.Interfaces.FieldData[]; + customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - font?: Word.Interfaces.FontData; + customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Gets the collection of `InlinePicture` objects in the paragraph. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + isMapped?: boolean; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItem?: Word.Interfaces.ListItemData; + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + prefixMappings?: boolean; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItemOrNullObject?: Word.Interfaces.ListItemData; + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xpath?: boolean; + } + /** + * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface CustomXmlPrefixMappingCollectionLoadOptions { /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - shading?: Word.Interfaces.ShadingUniversalData; + 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; /** - * Gets the collection of `Shape` objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. - */ - shapes?: Word.Interfaces.ShapeData[]; + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + namespaceUri?: boolean; /** - * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. + * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + prefix?: boolean; + } + /** + * Represents a `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface CustomXmlPrefixMappingLoadOptions { /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + 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; + /** + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - firstLineIndent?: number; + namespaceUri?: boolean; /** - * Indicates the paragraph is the last one inside its parent body. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - isLastParagraph?: boolean; + prefix?: boolean; + } + /** + * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface CustomXmlSchemaLoadOptions { /** - * Checks whether the paragraph is a list item. + 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; + /** + * Gets the location of the schema on a computer. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - isListItem?: boolean; + location?: boolean; /** - * Specifies the left indent value, in points, for the paragraph. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - leftIndent?: number; + namespaceUri?: boolean; + } + /** + * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface CustomXmlSchemaCollectionLoadOptions { /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + 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; + /** + * For EACH ITEM in the collection: Gets the location of the schema on a computer. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - lineSpacing?: number; + location?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - lineUnitAfter?: number; + namespaceUri?: boolean; + } + /** + * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface CustomXmlNodeCollectionLoadOptions { + /** + 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; + /** + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + /** + * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. - * - * @remarks - * [Api set: WordApi 1.1] - */ - lineUnitBefore?: number; + * For EACH ITEM in the collection: Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Specifies the outline level for the paragraph. - * - * @remarks - * [Api set: WordApi 1.1] - */ - outlineLevel?: number; + * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the right indent value, in points, for the paragraph. - * - * @remarks - * [Api set: WordApi 1.1] - */ - rightIndent?: number; + * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the spacing, in points, after the paragraph. + * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - spaceAfter?: number; + baseName?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - spaceBefore?: number; + namespaceUri?: boolean; /** - * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Gets the type of the current node. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - style?: string; + nodeType?: boolean; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Specifies the value of the current node. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + nodeValue?: boolean; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * For EACH ITEM in the collection: Specifies the text for the current node. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - tableNestingLevel?: number; + text?: boolean; /** - * Gets the text of the paragraph. + * For EACH ITEM in the collection: Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - text?: string; + xpath?: boolean; /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.3] */ - uniqueLocalId?: string; - } - /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ - interface ParagraphCollectionData { - items?: Word.Interfaces.ParagraphData[]; + xml?: boolean; } - /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ - interface ParagraphFormatData { + /** + * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface CustomXmlNodeLoadOptions { /** - * Specifies the alignment for the specified paragraphs. - * - * @remarks - * [Api set: WordApi 1.5] + 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`). */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + $all?: boolean; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. - * - * @remarks - * [Api set: WordApi 1.5] - */ - firstLineIndent?: number; + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. - * - * @remarks - * [Api set: WordApi 1.5] - */ - keepTogether?: boolean; + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. - * - * @remarks - * [Api set: WordApi 1.5] - */ - keepWithNext?: boolean; + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the left indent. - * - * @remarks - * [Api set: WordApi 1.5] - */ - leftIndent?: number; + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Specifies the line spacing (in points) for the specified paragraphs. - * - * @remarks - * [Api set: WordApi 1.5] - */ - lineSpacing?: number; + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. - * - * @remarks - * [Api set: WordApi 1.5] - */ - lineUnitAfter?: number; + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - lineUnitBefore?: number; + baseName?: boolean; /** - * Specifies whether left and right indents are the same width. + * Gets the unique address identifier for the namespace of the node. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - mirrorIndents?: boolean; + namespaceUri?: boolean; /** - * Specifies the outline level for the specified paragraphs. + * Gets the type of the current node. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + nodeType?: boolean; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies the value of the current node. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - rightIndent?: number; + nodeValue?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the text for the current node. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - spaceAfter?: number; + text?: boolean; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - spaceBefore?: number; + xpath?: boolean; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Gets the XML representation of the current node and its children. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - widowControl?: boolean; + xml?: boolean; } - /** An interface describing the data returned by calling `range.toJSON()`. */ - interface RangeData { + /** + * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface ContentControlLoadOptions { /** - * Gets the collection of `Field` objects in the range. + 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; + /** + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - fields?: Word.Interfaces.FieldData[]; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.7] */ - font?: Word.Interfaces.FontData; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Gets a `FrameCollection` object that represents all the frames in the range. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ - frames?: Word.Interfaces.FrameData[]; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontLoadOptions; + /** + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Gets the collection of `InlinePicture` objects in the range. + * Gets the parent body of the content control. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.3] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - listFormat?: Word.Interfaces.ListFormatData; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the collection of pages in the range. + * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pages?: Word.Interfaces.PageData[]; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the collection of sections in the range. + * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - sections?: Word.Interfaces.SectionData[]; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - shading?: Word.Interfaces.ShadingUniversalData; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the collection of `Shape` objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + */ + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + /** + * Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * - * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + * @remarks + * [Api set: WordApi 1.3] */ - shapes?: Word.Interfaces.ShapeData[]; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ - tableColumns?: Word.Interfaces.TableColumnData[]; - /** - * Specifies the proofing status (spelling and grammar checking) of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - hasNoProofing?: boolean; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. - * - * @remarks - * [Api set: WordApi 1.3] - */ - hyperlink?: string; + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * Checks whether the range length is zero. - * - * @remarks - * [Api set: WordApi 1.3] - */ - isEmpty?: boolean; + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Specifies the appearance of the content control. The value can be `boundingBox`, `tags`, or `hidden`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - languageDetected?: boolean; + appearance?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + cannotDelete?: boolean; /** - * Specifies an East Asian language for the range. + * Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + cannotEdit?: boolean; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + color?: boolean; /** - * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets an integer that represents the content control identifier. * * @remarks * [Api set: WordApi 1.1] */ - style?: string; + id?: boolean; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + placeholderText?: boolean; /** - * Gets the text of the range. + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ - text?: string; - } - /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ - interface RangeCollectionData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ - interface SearchOptionsData { + removeWhenEdited?: boolean; /** - * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. + * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the `styleBuiltIn` property. * * @remarks * [Api set: WordApi 1.1] */ - ignorePunct?: boolean; + style?: boolean; /** - * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the `style` property. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - ignoreSpace?: boolean; + styleBuiltIn?: boolean; /** - * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. + * Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchCase?: boolean; + subtype?: boolean; /** - * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. + * Specifies a tag to identify a content control. * * @remarks * [Api set: WordApi 1.1] */ - matchPrefix?: boolean; + tag?: boolean; /** - * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. + * Gets the text of the content control. * * @remarks * [Api set: WordApi 1.1] */ - matchSuffix?: boolean; + text?: boolean; /** - * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. + * Specifies the title for a content control. * * @remarks * [Api set: WordApi 1.1] */ - matchWholeWord?: boolean; + title?: boolean; /** - * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. + * Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. * * @remarks * [Api set: WordApi 1.1] */ - matchWildcards?: boolean; + type?: boolean; } - /** An interface describing the data returned by calling `section.toJSON()`. */ - interface SectionData { + /** + * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface ContentControlCollectionLoadOptions { /** - * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. + 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; + /** + * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - body?: Word.Interfaces.BodyData; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the section. + * For EACH ITEM in the collection: Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.7] */ - borders?: Word.Interfaces.BorderUniversalData[]; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Returns a `PageSetup` object that's associated with the section. + * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ - pageSetup?: Word.Interfaces.PageSetupData; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Specifies if the section is protected for forms. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - protectedForForms?: boolean; - } - /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ - interface SectionCollectionData { - items?: Word.Interfaces.SectionData[]; - } - /** An interface describing the data returned by calling `setting.toJSON()`. */ - interface SettingData { + * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontLoadOptions; /** - * Gets the key of the setting. - * - * @remarks - * [Api set: WordApi 1.4] - */ - key?: string; + * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Specifies the value of the setting. - * - * @remarks - * [Api set: WordApi 1.4] - */ - value?: any; - } - /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ - interface SettingCollectionData { - items?: Word.Interfaces.SettingData[]; - } - /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ - interface StyleCollectionData { - items?: Word.Interfaces.StyleData[]; - } - /** An interface describing the data returned by calling `style.toJSON()`. */ - interface StyleData { + * For EACH ITEM in the collection: Gets the parent body of the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies a `BorderCollection` object that represents all the borders for the style. + * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - borders?: Word.Interfaces.BorderData[]; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets a `Font` object that represents the character formatting of the style. + * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontData; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] + */ + parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] */ - frame?: Word.Interfaces.FrameData; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies a link between a paragraph and a character style. + * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - linkStyle?: Word.Interfaces.StyleData; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets a `ListTemplate` object that represents the list formatting for the style. + * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - listTemplate?: Word.Interfaces.ListTemplateData; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatData; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.3] */ - shading?: Word.Interfaces.ShadingData; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * Gets a `TableStyle` object representing style properties that can be applied to a table. + * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.3] */ - tableStyle?: Word.Interfaces.TableStyleData; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Specifies whether the style is automatically redefined based on the selection. + * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be `boundingBox`, `tags`, or `hidden`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - automaticallyUpdate?: boolean; + appearance?: boolean; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi 1.1] */ - baseStyle?: string; + cannotDelete?: boolean; /** - * Gets whether the style is a built-in style. + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - builtIn?: boolean; + cannotEdit?: boolean; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - hasProofing?: boolean; + color?: boolean; /** - * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - inUse?: boolean; + id?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the style. + * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + placeholderText?: boolean; /** - * Specifies an East Asian language for the style. + * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + removeWhenEdited?: boolean; /** - * Gets whether the style is a linked style that can be used for both paragraph and character formatting. + * For EACH ITEM in the collection: Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the `styleBuiltIn` property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - linked?: boolean; + style?: boolean; /** - * Returns the list level for the style. + * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the `style` property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - listLevelNumber?: number; + styleBuiltIn?: boolean; /** - * Specifies whether the style cannot be changed or edited. + * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - locked?: boolean; + subtype?: boolean; /** - * Gets the name of the style in the language of the user. + * For EACH ITEM in the collection: Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - nameLocal?: string; + tag?: boolean; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. + * For EACH ITEM in the collection: Gets the text of the content control. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi 1.1] */ - nextParagraphStyle?: string; + text?: boolean; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * For EACH ITEM in the collection: Specifies the title for a content control. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + title?: boolean; /** - * Specifies the priority. + * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - priority?: number; + type?: boolean; + } + /** + * Represents a list item in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + interface ContentControlListItemLoadOptions { /** - * Specifies whether the style corresponds to an available quick style. - * - * @remarks - * [Api set: WordApi 1.5] + 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`). */ - quickStyle?: boolean; + $all?: boolean; /** - * Gets the style type. + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.9] */ - type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + displayText?: boolean; /** - * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.9] */ - unhideWhenUsed?: boolean; + index?: boolean; /** - * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.9] */ - visibility?: boolean; + value?: boolean; } - /** An interface describing the data returned by calling `shading.toJSON()`. */ - interface ShadingData { + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + interface ContentControlListItemCollectionLoadOptions { /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + 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; + /** + * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.9] */ - backgroundPatternColor?: string; + displayText?: boolean; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.9] */ - foregroundPatternColor?: string; + index?: boolean; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.9] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + value?: boolean; } - /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ - interface ShadingUniversalData { + /** + * Represents a custom property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface CustomPropertyLoadOptions { /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + 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; + /** + * Gets the key of the custom property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - backgroundPatternColor?: string; + key?: boolean; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + type?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - foregroundPatternColor?: string; + value?: boolean; + } + /** + * Contains the collection of {@link Word.CustomProperty} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface CustomPropertyCollectionLoadOptions { /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + 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; + /** + * For EACH ITEM in the collection: Gets the key of the custom property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + key?: boolean; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + type?: boolean; + /** + * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: boolean; } - /** An interface describing the data returned by calling `table.toJSON()`. */ - interface TableData { + /** + * Represents a custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CustomXmlPartLoadOptions { /** - * Gets the collection of `Field` objects in the table. - * - * @remarks - * [Api set: WordApi 1.4] - */ - fields?: Word.Interfaces.FieldData[]; + 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; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - font?: Word.Interfaces.FontData; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets all of the table rows. - * - * @remarks - * [Api set: WordApi 1.3] - */ - rows?: Word.Interfaces.TableRowData[]; + * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + builtIn?: boolean; /** - * Gets the child tables nested one level deeper. - * - * @remarks - * [Api set: WordApi 1.3] - */ - tables?: Word.Interfaces.TableData[]; + * Gets the ID of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; /** - * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + namespaceUri?: boolean; /** - * Specifies the number of header rows. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - headerRowCount?: number; + xml?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CustomXmlPartCollectionLoadOptions { /** - * Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. + 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; + /** + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + /** + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + builtIn?: boolean; /** - * Indicates whether all of the table rows are uniform. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - isUniform?: boolean; + id?: boolean; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - nestingLevel?: number; + namespaceUri?: boolean; /** - * Gets the number of rows in the table. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - rowCount?: number; + xml?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CustomXmlPartScopedCollectionLoadOptions { /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + 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; + /** + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + /** + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - shadingColor?: string; + builtIn?: boolean; /** - * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - style?: string; + id?: boolean; /** - * Specifies whether the table has banded columns. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - styleBandedColumns?: boolean; + namespaceUri?: boolean; /** - * Specifies whether the table has banded rows. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - styleBandedRows?: boolean; + xml?: boolean; + } + /** + * The `Document` object is the top level object. A `Document` object contains one or more sections, content controls, and the body that contains the contents of the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface DocumentLoadOptions { /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + 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; + /** + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activeWindow?: Word.Interfaces.WindowLoadOptions; + /** + * Specifies a `Template` object that represents the template attached to the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + attachedTemplate?: Word.Interfaces.TemplateLoadOptions; + /** + * Gets a `Shape` object that represents the background image for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + background?: Word.Interfaces.ShapeLoadOptions; + /** + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + bibliography?: Word.Interfaces.BibliographyLoadOptions; + /** + * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ + body?: Word.Interfaces.BodyLoadOptions; + /** + * Gets a `DocumentProperties` object that represents all the built-in document properties for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + builtInDocumentProperties?: Word.Interfaces.DocumentPropertiesLoadOptions; + /** + * Gets a `Coauthoring` object for managing coauthoring in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + coauthoring?: Word.Interfaces.CoauthoringLoadOptions; + /** + * Gets a `Range` object that represents the main document story. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + content?: Word.Interfaces.RangeLoadOptions; + /** + * Gets a `DocumentProperties` collection that represents all the custom document properties for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + customDocumentProperties?: Word.Interfaces.DocumentPropertiesLoadOptions; + /** + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageSetup?: Word.Interfaces.PageSetupLoadOptions; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + /** + * Returns a `Selection` object that represents the current selection in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selection?: Word.Interfaces.SelectionLoadOptions; + /** + * Gets the `WebSettings` object for webpage-related attributes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + webSettings?: Word.Interfaces.WebSettingsLoadOptions; + /** + * Gets the name of the active theme and formatting options. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + activeTheme?: boolean; /** - * Specifies whether the table has a first column with a special style. + * Gets the display name of the active theme. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleFirstColumn?: boolean; + activeThemeDisplayName?: boolean; /** - * Specifies whether the table has a last column with a special style. + * Gets whether Word encrypts file properties for password-protected documents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleLastColumn?: boolean; + areFilePropertiesPasswordEncrypted?: boolean; /** - * Specifies whether the table has a total (last) row with a special style. + * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleTotalRow?: boolean; + areGrammaticalErrorsShown?: boolean; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Specifies whether to use the default math settings when creating new equations. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - values?: string[][]; + areMathDefaultsUsed?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. + * Specifies whether to disable features introduced after a specified version. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + areNewerFeaturesDisabled?: boolean; /** - * Specifies the width of the table in points. + * Specifies whether Microsoft Word underlines spelling errors in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ - interface TableStyleData { + areSpellingErrorsShown?: boolean; /** - * Specifies the table's alignment against the page margin. + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areStylesUpdatedOnOpen?: boolean; /** - * Specifies whether lines in tables formatted with a style break across pages. + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - allowBreakAcrossPage?: boolean; + areTrueTypeFontsEmbedded?: boolean; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.3] */ - bottomCellMargin?: number; + autoHyphenation?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * Specifies if the edits in the document are automatically saved. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.3] */ - cellSpacing?: number; + autoSaveOn?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.4] */ - leftCellMargin?: number; + changeTrackingMode?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Gets the code name for the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - rightCellMargin?: number; + codeName?: boolean; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Gets the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - topCellMargin?: number; - } - /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ - interface TableCollectionData { - items?: Word.Interfaces.TableData[]; - } - /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ - interface TableColumnData { - /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - borders?: Word.Interfaces.BorderUniversalData[]; - /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - shading?: Word.Interfaces.ShadingUniversalData; + compatibilityMode?: boolean; /** - * Returns the position of this column in a collection. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks * [Api set: WordApiDesktop 1.3] */ - columnIndex?: number; + consecutiveHyphensLimit?: boolean; /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Gets a random number that Word assigns to changes in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isFirst?: boolean; + currentRsid?: boolean; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Specifies the interval (in points) between the default tab stops in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isLast?: boolean; + defaultTabStop?: boolean; /** - * Returns the nesting level of the column. + * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nestingLevel?: number; + defaultTargetFrame?: boolean; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredWidth?: number; + doNotEmbedSystemFonts?: boolean; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + encryptionProvider?: boolean; /** - * Specifies the width of the column, in points. + * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ - interface TableColumnCollectionData { - items?: Word.Interfaces.TableColumnData[]; - } - /** An interface describing the data returned by calling `tableRow.toJSON()`. */ - interface TableRowData { - /** - * Gets cells. - * - * @remarks - * [Api set: WordApi 1.3] - */ - cells?: Word.Interfaces.TableCellData[]; - /** - * Gets the collection of `Field` objects in the table row. - * - * @remarks - * [Api set: WordApi 1.4] - */ - fields?: Word.Interfaces.FieldData[]; - /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - font?: Word.Interfaces.FontData; + farEastLineBreakLanguage?: boolean; /** - * Gets the number of cells in the row. + * Specifies the line break control level. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - cellCount?: number; + farEastLineBreakLevel?: boolean; /** - * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. + * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + formattingIsNextLevelShown?: boolean; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. + * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - isHeader?: boolean; + formattingIsUserStyleNameShown?: boolean; /** - * Specifies the preferred height of the row in points. + * Gets the name of a document, including the path. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredHeight?: number; + fullName?: boolean; /** - * Gets the index of the row in its parent table. + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - rowIndex?: number; + gridDistanceHorizontal?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - shadingColor?: string; + gridDistanceVertical?: boolean; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - values?: string[][]; + gridIsOriginFromMargin?: boolean; /** - * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. + * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ - interface TableRowCollectionData { - items?: Word.Interfaces.TableRowData[]; - } - /** An interface describing the data returned by calling `tableCell.toJSON()`. */ - interface TableCellData { - /** - * Gets the `Body` object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - body?: Word.Interfaces.BodyData; + gridOriginHorizontal?: boolean; /** - * Gets the index of the cell in its row. + * Specifies the vertical origin point for the invisible grid. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - cellIndex?: number; + gridOriginVertical?: boolean; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - columnWidth?: number; + gridSpaceBetweenHorizontalLines?: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. + * Specifies the interval for vertical character gridlines in print layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + gridSpaceBetweenVerticalLines?: boolean; /** - * Gets the index of the cell's row in the table. + * Gets whether a password is required to open the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - rowIndex?: number; + hasPassword?: boolean; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - shadingColor?: string; + hasVbProject?: boolean; /** - * Specifies the text of the cell. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - value?: string; + hyphenateCaps?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. + * Specifies the width of the hyphenation zone, in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + hyphenationZone?: boolean; /** - * Gets the width of the cell in points. + * Specifies whether automatic formatting options override formatting restrictions. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ - interface TableCellCollectionData { - items?: Word.Interfaces.TableCellData[]; - } - /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ - interface TableBorderData { + isAutoFormatOverrideOn?: boolean; /** - * Specifies the table border color. + * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - color?: string; + isChartDataPointTracked?: boolean; /** - * Specifies the type of the table border. + * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + isCompatible?: boolean; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies whether the document is final. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** An interface describing the data returned by calling `template.toJSON()`. */ - interface TemplateData { + isFinal?: boolean; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + isFontsSubsetSaved?: boolean; /** - * Specifies the line break control level for the document. + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + isFormsDataPrinted?: boolean; /** - * Returns the name of the template, including the drive or Web path. + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - fullName?: string; + isFormsDataSaved?: boolean; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies whether a grammar check has been run on the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - hasNoProofing?: boolean; + isGrammarChecked?: boolean; /** - * Specifies the character spacing adjustment for the template. + * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + isInAutoSave?: boolean; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Gets whether the document is in form design mode. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - kerningByAlgorithm?: boolean; + isInFormsDesign?: boolean; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Specifies whether Word kerns half-width Latin characters and punctuation marks. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isKerningByAlgorithm?: boolean; /** - * Specifies an East Asian language for the language in the template. + * Specifies whether to embed speech and handwriting data. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isLinguisticDataEmbedded?: boolean; /** - * Returns only the name of the document template (excluding any path or other location information). + * Gets whether this document is a master document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - name?: string; + isMasterDocument?: boolean; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies whether Word optimizes the document for Word 97. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - noLineBreakAfter?: string; + isOptimizedForWord97?: boolean; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - noLineBreakBefore?: string; + isPostScriptPrintedOverText?: boolean; /** - * Returns the path to the document template. + * Specifies whether users can change the Quick Style set. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - path?: string; + isQuickStyleSetLocked?: boolean; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Gets whether changes to the document cannot be saved to the original document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - saved?: boolean; + isReadOnly?: boolean; /** - * Returns the template type. + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.TemplateType | "Normal" | "Global" | "Attached"; - } - /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ - interface TemplateCollectionData { - items?: Word.Interfaces.TemplateData[]; - } - /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ - interface TrackedChangeData { + isReadOnlyRecommended?: boolean; /** - * Gets the author of the tracked change. + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - author?: string; + isSnappedToGrid?: boolean; /** - * Gets the date of the tracked change. + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - date?: Date; + isSnappedToShapes?: boolean; /** - * Gets the text of the tracked change. + * Specifies whether spelling has been checked throughout the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - text?: string; + isSpellingChecked?: boolean; /** - * Gets the type of the tracked change. + * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; - } - /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ - interface TrackedChangeCollectionData { - items?: Word.Interfaces.TrackedChangeData[]; - } - /** An interface describing the data returned by calling `shape.toJSON()`. */ - interface ShapeData { - /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - body?: Word.Interfaces.BodyData; - /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - canvas?: Word.Interfaces.CanvasData; - /** - * Returns the fill formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - fill?: Word.Interfaces.ShapeFillData; - /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - parentCanvas?: Word.Interfaces.ShapeData; - /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - parentGroup?: Word.Interfaces.ShapeData; - /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - shapeGroup?: Word.Interfaces.ShapeGroupData; - /** - * Gets the `TextFrame` object of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - textFrame?: Word.Interfaces.TextFrameData; - /** - * Returns the text wrap formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - textWrap?: Word.Interfaces.ShapeTextWrapData; + isStyleEnforced?: boolean; /** - * Specifies whether a given shape can overlap other shapes. + * Gets whether this document is a subdocument of a master document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - allowOverlap?: boolean; + isSubdocument?: boolean; /** - * Specifies a string that represents the alternative text associated with the shape. + * Specifies whether users can change the document theme. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - altTextDescription?: string; + isThemeLocked?: boolean; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies whether the document was created or opened by the user. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + isUserControl?: boolean; /** - * The height, in points, of the shape. + * Gets whether the VBA project is digitally signed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - height?: number; + isVbaSigned?: boolean; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Gets whether the document is protected with a write password. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - heightRelative?: number; + isWriteReserved?: boolean; /** - * Gets an integer that represents the shape identifier. + * Specifies the character spacing adjustment. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - id?: number; + justificationMode?: boolean; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - isChild?: boolean; + kind?: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - left?: number; + languageDetected?: boolean; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the kinsoku characters after which Word will not break a line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftRelative?: number; + noLineBreakAfter?: boolean; /** - * Specifies if the aspect ratio of this shape is locked. + * Specifies the kinsoku characters before which Word will not break a line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - lockAspectRatio?: boolean; + noLineBreakBefore?: boolean; /** - * The name of the shape. + * Gets the encoding used to open the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - name?: string; + openEncoding?: boolean; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets the title of the original document after legal-blackline comparison. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + originalDocumentTitle?: boolean; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Sets a password that must be supplied to open the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + password?: boolean; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Gets the algorithm used for password encryption. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + passwordEncryptionAlgorithm?: boolean; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + passwordEncryptionKeyLength?: boolean; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Gets the name of the password encryption provider. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - rotation?: number; + passwordEncryptionProvider?: boolean; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Gets the disk or the web path to the document (excludes the document name). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - top?: number; + path?: boolean; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies whether revision marks are printed with the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - topRelative?: number; + printRevisions?: boolean; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Gets the protection type for the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + protectionType?: boolean; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - visible?: boolean; + readingLayoutSizeX?: boolean; /** - * The width, in points, of the shape. + * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - width?: number; + readingLayoutSizeY?: boolean; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - widthRelative?: number; - } - /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ - interface ShapeGroupData { - /** - * Gets the `Shape` object associated with the group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - shape?: Word.Interfaces.ShapeData; - /** - * Gets the collection of `Shape` objects. Currently, only text boxes, geometric shapes, and pictures are supported. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - shapes?: Word.Interfaces.ShapeData[]; + readingModeIsLayoutFrozen?: boolean; /** - * Gets an integer that represents the shape group identifier. + * Specifies whether Word removes user information upon saving. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - id?: number; - } - /** An interface describing the data returned by calling `canvas.toJSON()`. */ - interface CanvasData { - /** - * Gets the `Shape` object associated with the canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - shape?: Word.Interfaces.ShapeData; - /** - * Gets the collection of {@link Word.Shape} objects. Currently, only text boxes, pictures, and geometric shapes are supported. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - shapes?: Word.Interfaces.ShapeData[]; + removePersonalInformationOnSave?: boolean; /** - * Gets an integer that represents the canvas identifier. + * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - id?: number; - } - /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ - interface ShapeCollectionData { - items?: Word.Interfaces.ShapeData[]; - } - /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ - interface ShapeFillData { + revisedDocumentTitle?: boolean; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the encoding used when saving the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - backgroundColor?: string; + saveEncoding?: boolean; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the file format of the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - foregroundColor?: string; + saveFormat?: boolean; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - transparency?: number; + saved?: boolean; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Specifies the encoding for saving as encoded text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; - } - /** An interface describing the data returned by calling `textFrame.toJSON()`. */ - interface TextFrameData { + textEncoding?: boolean; /** - * Specifies the automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * Specifies how Word marks line and paragraph breaks in text files. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + textLineEnding?: boolean; /** - * Specifies the bottom margin, in points, of the text frame. + * Specifies whether to track formatting changes when change tracking is on. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - bottomMargin?: number; + trackFormatting?: boolean; /** - * Returns `true` if the text frame contains text, otherwise, `false`. + * Specifies whether to mark moved text when Track Changes is on. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - hasText?: boolean; + trackMoves?: boolean; /** - * Specifies the left margin, in points, of the text frame. + * Specifies whether changes are tracked in the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - leftMargin?: number; + trackRevisions?: boolean; /** - * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. + * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - noTextRotation?: boolean; + trackedChangesAreDateAndTimeRemoved?: boolean; /** - * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Gets the document type (template or document). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + type?: boolean; /** - * Specifies the right margin, in points, of the text frame. + * Sets a password for saving changes to the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - rightMargin?: number; + writePassword?: boolean; /** - * Specifies the top margin, in points, of the text frame. + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - topMargin?: number; + xmlAreAdvancedErrorsShown?: boolean; /** - * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + xmlIsXsltUsedWhenSaving?: boolean; /** - * Determines whether lines break automatically to fit text inside the shape. + * Specifies the path and file name for the XSLT to apply when saving a document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - wordWrap?: boolean; + xmlSaveThroughXslt?: boolean; } - /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ - interface ShapeTextWrapData { + /** + * The `DocumentCreated` object is the top level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface DocumentCreatedLoadOptions { /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + 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`). */ - bottomDistance?: number; + $all?: boolean; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Gets the `Body` object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + body?: Word.Interfaces.BodyLoadOptions; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + /** + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiHiddenDocument 1.3] */ - leftDistance?: number; + saved?: boolean; + } + /** + * Represents document properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface DocumentPropertiesLoadOptions { /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + 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`). */ - rightDistance?: number; + $all?: boolean; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Gets the application name of the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + applicationName?: boolean; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies the author of the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - topDistance?: number; + author?: boolean; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies the category of the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; - } - /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ - interface RepeatingSectionItemData { - /** - * Returns the range of this repeating section item, excluding the start and end tags. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeData; - } - /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ - interface DatePickerContentControlData { - /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - placeholderText?: Word.Interfaces.BuildingBlockData; - /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeData; - /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - xmlMapping?: Word.Interfaces.XmlMappingData; + category?: boolean; /** - * Specifies the appearance of the content control. + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + comments?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the company of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - color?: string; + company?: boolean; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Gets the creation date of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + creationDate?: boolean; /** - * Specifies the format in which dates are displayed. + * Specifies the format of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - dateDisplayFormat?: string; + format?: boolean; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies the keywords of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + keywords?: boolean; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Gets the last author of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + lastAuthor?: boolean; /** - * Gets the identification for the content control. + * Gets the last print date of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - id?: string; + lastPrintDate?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the last save time of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - isTemporary?: boolean; + lastSaveTime?: boolean; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + manager?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - lockContentControl?: boolean; + revisionNumber?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - lockContents?: boolean; + security?: boolean; /** - * Gets whether the placeholder text for the content control is being displayed. + * Specifies the subject of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - showingPlaceholderText?: boolean; + subject?: boolean; /** - * Specifies a tag to identify the content control. + * Gets the template of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - tag?: string; + template?: boolean; /** - * Specifies the title for the content control. + * Specifies the title of the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - title?: string; + title?: boolean; } - /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ - interface PictureContentControlData { + /** + * Represents a field. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + */ + interface FieldLoadOptions { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + 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; + /** + * Gets a `LinkFormat` object that represents the link options of the field. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - placeholderText?: Word.Interfaces.BuildingBlockData; + linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - range?: Word.Interfaces.RangeData; + oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the parent body of the field. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - xmlMapping?: Word.Interfaces.XmlMappingData; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the appearance of the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - color?: string; + * Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Returns the identification for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - id?: string; + * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - isTemporary?: boolean; + * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + /** + * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeLoadOptions; + /** + * Specifies the field's code instruction. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + code?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - lockContentControl?: boolean; + data?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the field's kind. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - lockContents?: boolean; + kind?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - showingPlaceholderText?: boolean; + locked?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - tag?: string; + showCodes?: boolean; /** - * Specifies the title for the content control. + * Gets the field's type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - title?: string; + type?: boolean; } - /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ - interface GroupContentControlData { + /** + * Contains a collection of {@link Word.Field} objects. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + */ + interface FieldCollectionLoadOptions { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + 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; + /** + * For EACH ITEM in the collection: Gets a `LinkFormat` object that represents the link options of the field. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - placeholderText?: Word.Interfaces.BuildingBlockData; + linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * For EACH ITEM in the collection: Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - range?: Word.Interfaces.RangeData; + oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * For EACH ITEM in the collection: Gets the parent body of the field. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] */ - xmlMapping?: Word.Interfaces.XmlMappingData; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the appearance of the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - color?: string; + * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Returns the identification for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - id?: string; + * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - isTemporary?: boolean; + * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the field's code instruction. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + code?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * For EACH ITEM in the collection: Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - lockContentControl?: boolean; + data?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * For EACH ITEM in the collection: Gets the field's kind. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - lockContents?: boolean; + kind?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * For EACH ITEM in the collection: Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - showingPlaceholderText?: boolean; + locked?: boolean; /** - * Specifies a tag to identify the content control. + * For EACH ITEM in the collection: Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - tag?: string; + showCodes?: boolean; /** - * Specifies the title for the content control. + * For EACH ITEM in the collection: Gets the field's type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - title?: string; + type?: boolean; } - /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ - interface BuildingBlockGalleryContentControlData { + /** + * Represents a font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface FontLoadOptions { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + 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; + /** + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - placeholderText?: Word.Interfaces.BuildingBlockData; + fill?: Word.Interfaces.FillFormatLoadOptions; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeData; + glow?: Word.Interfaces.GlowFormatLoadOptions; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xmlMapping?: Word.Interfaces.XmlMappingData; + line?: Word.Interfaces.LineFormatLoadOptions; /** - * Specifies the appearance of the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + reflection?: Word.Interfaces.ReflectionFormatLoadOptions; /** - * Specifies the category for the building block content control. + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textColor?: Word.Interfaces.ColorFormatLoadOptions; + /** + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + textShadow?: Word.Interfaces.ShadowFormatLoadOptions; + /** + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatLoadOptions; + /** + * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * * @remarks * [Api set: WordApiDesktop 1.3] */ - buildingBlockCategory?: string; + allCaps?: boolean; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + bold?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. * * @remarks * [Api set: WordApiDesktop 1.3] */ - color?: string; + boldBidirectional?: boolean; /** - * Gets the identification for the content control. + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - id?: string; + color?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isTemporary?: boolean; + colorIndex?: boolean; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + colorIndexBidirectional?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether contextual alternates are enabled for the font. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContentControl?: boolean; + contextualAlternates?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContents?: boolean; + diacriticColor?: boolean; /** - * Gets if the placeholder text for the content control is being displayed. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - showingPlaceholderText?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - tag?: string; + doubleStrikeThrough?: boolean; /** - * Specifies the title for the content control. + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. * * @remarks * [Api set: WordApiDesktop 1.3] */ - title?: string; - } - /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ - interface RepeatingSectionContentControlData { - /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - placeholderText?: Word.Interfaces.BuildingBlockData; - /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeData; + emboss?: boolean; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApiDesktop 1.3] */ - allowInsertDeleteSection?: boolean; + emphasisMark?: boolean; /** - * Specifies the appearance of the content control. + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. * * @remarks * [Api set: WordApiDesktop 1.3] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + engrave?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - color?: string; + hidden?: boolean; /** - * Returns the identification for the content control. + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to `null`. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - id?: string; + highlightColor?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - isTemporary?: boolean; + italic?: boolean; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. * * @remarks * [Api set: WordApiDesktop 1.3] */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + italicBidirectional?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContentControl?: boolean; + kerning?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the ligature setting for the `Font` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContents?: boolean; + ligature?: boolean; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Specifies the name of the font. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - repeatingSectionItemTitle?: string; + name?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * * @remarks * [Api set: WordApiDesktop 1.3] */ - showingPlaceholderText?: boolean; + nameAscii?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the font name in a right-to-left language document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - tag?: string; + nameBidirectional?: boolean; /** - * Specifies the title for the content control. + * Specifies the East Asian font name. * * @remarks * [Api set: WordApiDesktop 1.3] */ - title?: string; - } - /** An interface describing the data returned by calling `frame.toJSON()`. */ - interface FrameData { - /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - borders?: Word.Interfaces.BorderUniversalData[]; - /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeData; - /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - shading?: Word.Interfaces.ShadingUniversalData; + nameFarEast?: boolean; /** - * Specifies the height (in points) of the frame. + * Specifies the font used for characters with codes from 128 through 255. * * @remarks * [Api set: WordApiDesktop 1.3] */ - height?: number; + nameOther?: boolean; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies the number form setting for an OpenType font. * * @remarks * [Api set: WordApiDesktop 1.3] */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + numberForm?: boolean; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the number spacing setting for the font. * * @remarks * [Api set: WordApiDesktop 1.3] */ - horizontalDistanceFromText?: number; + numberSpacing?: boolean; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. * * @remarks * [Api set: WordApiDesktop 1.3] */ - horizontalPosition?: number; + outline?: boolean; /** - * Specifies if the frame is locked. + * Specifies the position of text (in points) relative to the base line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockAnchor?: boolean; + position?: boolean; /** - * Specifies the relative horizontal position of the frame. + * Specifies the scaling percentage applied to the font. * * @remarks * [Api set: WordApiDesktop 1.3] */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + scaling?: boolean; /** - * Specifies the relative vertical position of the frame. + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. * * @remarks * [Api set: WordApiDesktop 1.3] */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + shadow?: boolean; /** - * Specifies if document text wraps around the frame. + * Specifies the font size in points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - textWrap?: boolean; + size?: boolean; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies the font size in points for right-to-left text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - verticalDistanceFromText?: number; + sizeBidirectional?: boolean; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks * [Api set: WordApiDesktop 1.3] */ - verticalPosition?: number; + smallCaps?: boolean; /** - * Specifies the width (in points) of the frame. + * Specifies the spacing between characters. * * @remarks * [Api set: WordApiDesktop 1.3] */ - width?: number; + spacing?: boolean; /** - * Specifies the rule used to determine the width of the frame. + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; - } - /** An interface describing the data returned by calling `frameCollection.toJSON()`. */ - interface FrameCollectionData { - items?: Word.Interfaces.FrameData[]; - } - /** An interface describing the data returned by calling `documentLibraryVersion.toJSON()`. */ - interface DocumentLibraryVersionData { + strikeThrough?: boolean; /** - * Gets any optional comments associated with this version of the shared document. + * Specifies the stylistic set for the font. * * @remarks * [Api set: WordApiDesktop 1.3] */ - comments?: string; + stylisticSet?: boolean; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - modified?: any; + subscript?: boolean; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - modifiedBy?: string; - } - /** An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`. */ - interface DocumentLibraryVersionCollectionData { - items?: Word.Interfaces.DocumentLibraryVersionData[]; - } - /** An interface describing the data returned by calling `listFormat.toJSON()`. */ - interface ListFormatData { - /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - list?: Word.Interfaces.ListData; - /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - listTemplate?: Word.Interfaces.ListTemplateData; + superscript?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list. + * Specifies the font's underline type. `none` if the font isn't underlined. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - isSingleList?: boolean; + underline?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list template. + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isSingleListTemplate?: boolean; + underlineColor?: boolean; + } + /** + * Represents a heading style used in a table of contents or table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface HeadingStyleLoadOptions { /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + 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; + /** + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - listLevelNumber?: number; + level?: boolean; /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - listString?: string; + name?: boolean; + } + /** + * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface HeadingStyleCollectionLoadOptions { /** - * Gets the type of the list for the `ListFormat` object. + 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; + /** + * For EACH ITEM in the collection: Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + level?: boolean; /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * For EACH ITEM in the collection: Specifies the name of style for a heading. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - listValue?: number; + name?: boolean; } - /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ - interface FillFormatData { + /** + * Represents a hyperlink in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface HyperlinkLoadOptions { /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - backgroundColor?: Word.Interfaces.ColorFormatData; + 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; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - foregroundColor?: Word.Interfaces.ColorFormatData; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gradientAngle?: number; + address?: boolean; /** - * Gets the gradient color type. + * Specifies the text string for the hyperlink's subject line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + emailSubject?: boolean; /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gradientDegree?: number; + isExtraInfoRequired?: boolean; /** - * Returns the gradient style for the fill. + * Returns the name of the `Hyperlink` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + name?: boolean; /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gradientVariant?: number; + screenTip?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isVisible?: boolean; + subAddress?: boolean; /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + target?: boolean; /** - * Returns the preset gradient type for the fill. + * Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + textToDisplay?: boolean; /** - * Gets the preset texture. + * Returns the hyperlink type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + type?: boolean; + } + /** + * Contains a collection of {@link Word.Hyperlink} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface HyperlinkCollectionLoadOptions { /** - * Specifies whether the fill rotates with the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - rotateWithObject?: boolean; + $all?: boolean; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the horizontal scaling factor for the texture fill. + * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureHorizontalScale?: number; + address?: boolean; /** - * Returns the name of the custom texture file for the fill. + * For EACH ITEM in the collection: Specifies the text string for the hyperlink's subject line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureName?: string; + emailSubject?: boolean; /** - * Specifies the horizontal offset of the texture from the origin in points. + * For EACH ITEM in the collection: Returns `true` if extra information is required to resolve the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureOffsetX?: number; + isExtraInfoRequired?: boolean; /** - * Specifies the vertical offset of the texture. + * For EACH ITEM in the collection: Returns the name of the `Hyperlink` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureOffsetY?: number; + name?: boolean; /** - * Specifies whether the texture is tiled. + * For EACH ITEM in the collection: Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureTile?: boolean; + screenTip?: boolean; /** - * Returns the texture type for the fill. + * For EACH ITEM in the collection: Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + subAddress?: boolean; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * For EACH ITEM in the collection: Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureVerticalScale?: number; + target?: boolean; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * For EACH ITEM in the collection: Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - transparency?: number; + textToDisplay?: boolean; /** - * Gets the fill format type. + * For EACH ITEM in the collection: Returns the hyperlink type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + type?: boolean; } - /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ - interface GlowFormatData { + /** + * Represents an inline picture. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface InlinePictureLoadOptions { /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + 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; + /** + * Gets the parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.2] */ - color?: Word.Interfaces.ColorFormatData; + paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * Specifies the length of the radius for a glow effect. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - radius?: number; + * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - transparency?: number; - } - /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ - interface LineFormatData { + * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. + * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - backgroundColor?: Word.Interfaces.ColorFormatData; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. + * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - foregroundColor?: Word.Interfaces.ColorFormatData; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the length of the arrowhead at the beginning of the line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the style of the arrowhead at the beginning of the line. + * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + altTextDescription?: boolean; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + altTextTitle?: boolean; /** - * Specifies the dash style for the line. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + height?: boolean; /** - * Specifies the length of the arrowhead at the end of the line. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + hyperlink?: boolean; /** - * Specifies the style of the arrowhead at the end of the line. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + imageFormat?: boolean; /** - * Specifies the width of the arrowhead at the end of the line. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + lockAspectRatio?: boolean; /** - * Specifies if to draw lines inside a shape. + * Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - insetPen?: boolean; + width?: boolean; + } + /** + * Contains a collection of {@link Word.InlinePicture} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface InlinePictureCollectionLoadOptions { /** - * Specifies if the object, or the formatting applied to it, is visible. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - isVisible?: boolean; + $all?: boolean; /** - * Specifies the pattern applied to the line. + * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. + * + * @remarks + * [Api set: WordApi 1.2] + */ + paragraph?: Word.Interfaces.ParagraphLoadOptions; + /** + * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + /** + * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCell?: Word.Interfaces.TableCellLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + altTextDescription?: boolean; /** - * Specifies the line format style. + * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + altTextTitle?: boolean; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - transparency?: number; + height?: boolean; /** - * Specifies the thickness of the line in points. + * For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - weight?: number; - } - /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ - interface ReflectionFormatData { + hyperlink?: boolean; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * For EACH ITEM in the collection: Gets the format of the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - blur?: number; + imageFormat?: boolean; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - offset?: number; + lockAspectRatio?: boolean; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - size?: number; + width?: boolean; + } + /** + * Represents the linking characteristics for an OLE object or picture. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface LinkFormatLoadOptions { /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + 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; + /** + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - transparency?: number; + isAutoUpdated?: boolean; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; - } - /** An interface describing the data returned by calling `colorFormat.toJSON()`. */ - interface ColorFormatData { + isLocked?: boolean; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies if the linked picture is saved with the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - brightness?: number; + isPictureSavedWithDocument?: boolean; /** - * Specifies the theme color for a color format. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + sourceFullName?: boolean; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - rgb?: string; + sourceName?: boolean; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tintAndShade?: number; + sourcePath?: boolean; /** - * Returns the shape color type. + * Gets the link type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - type?: Word.ColorType | "rgb" | "scheme"; + type?: boolean; } - /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ - interface ShadowFormatData { + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListLoadOptions { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - foregroundColor?: Word.Interfaces.ColorFormatData; + 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; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Gets the list's ID. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - blur?: number; + id?: boolean; /** - * Specifies whether the object or the formatting applied to it is visible. + * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - isVisible?: boolean; + levelExistences?: boolean; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - obscured?: boolean; + levelTypes?: boolean; + } + /** + * Contains a collection of {@link Word.List} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListCollectionLoadOptions { /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - offsetX?: number; + $all?: boolean; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * For EACH ITEM in the collection: Gets the list's ID. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - offsetY?: number; + id?: boolean; /** - * Specifies whether to rotate the shadow when rotating the shape. + * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - rotateWithShape?: boolean; + levelExistences?: boolean; /** - * Specifies the width of the shadow. + * For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - size?: number; + levelTypes?: boolean; + } + /** + * Represents the paragraph list item format. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListItemLoadOptions { /** - * Specifies the type of shadow formatting to apply to a shape. + 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; + /** + * Specifies the level of the item in the list. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + level?: boolean; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the list item bullet, number, or picture as a string. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - transparency?: number; + listString?: boolean; /** - * Specifies the shape shadow type. + * Gets the list item order number in relation to its siblings. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + siblingIndex?: boolean; } - /** An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`. */ - interface ThreeDimensionalFormatData { + /** + * Represents a list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface ListLevelLoadOptions { /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - contourColor?: Word.Interfaces.ColorFormatData; + 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; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - extrusionColor?: Word.Interfaces.ColorFormatData; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the depth of the bottom bevel. + * Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - bevelBottomDepth?: number; + alignment?: boolean; /** - * Specifies the inset size for the bottom bevel. + * Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - bevelBottomInset?: number; + linkedStyle?: boolean; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Specifies the number format for the list level. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + numberFormat?: boolean; /** - * Specifies the depth of the top bevel. + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - bevelTopDepth?: number; + numberPosition?: boolean; /** - * Specifies the inset size for the top bevel. + * Specifies the number style for the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - bevelTopInset?: number; + numberStyle?: boolean; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * Specifies the list level that must appear before it restarts numbering at 1. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + resetOnHigher?: boolean; /** - * Specifies the width of the contour of a shape. + * Specifies the starting number for the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - contourWidth?: number; + startAt?: boolean; /** - * Specifies the depth of the shape's extrusion. + * Specifies the tab position for the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - depth?: number; + tabPosition?: boolean; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + textPosition?: boolean; /** - * Specifies the amount of perspective for a shape. + * Specifies the character inserted after the number for the list level. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - fieldOfView?: number; + trailingCharacter?: boolean; + } + /** + * Contains a collection of {@link Word.ListLevel} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface ListLevelCollectionLoadOptions { /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - isPerspective?: boolean; + $all?: boolean; /** - * Specifies if the specified object, or the formatting applied to it, is visible. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - isVisible?: boolean; + * For EACH ITEM in the collection: Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the angle of the lighting. + * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - lightAngle?: number; + alignment?: boolean; /** - * Returns a `PresetCamera` value that represents the camera presets. + * For EACH ITEM in the collection: Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - presetCamera?: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + linkedStyle?: boolean; /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * For EACH ITEM in the collection: Specifies the number format for the list level. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + numberFormat?: boolean; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + numberPosition?: boolean; /** - * Specifies the position of the light source relative to the extrusion. + * For EACH ITEM in the collection: Specifies the number style for the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + numberStyle?: boolean; /** - * Specifies the intensity of the extrusion lighting. + * For EACH ITEM in the collection: Specifies the list level that must appear before it restarts numbering at 1. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + resetOnHigher?: boolean; /** - * Specifies the extrusion surface material. + * For EACH ITEM in the collection: Specifies the starting number for the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + startAt?: boolean; /** - * Returns the preset extrusion format. + * For EACH ITEM in the collection: Specifies the tab position for the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + tabPosition?: boolean; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - projectText?: boolean; + textPosition?: boolean; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * For EACH ITEM in the collection: Specifies the character inserted after the number for the list level. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - rotationX?: number; + trailingCharacter?: boolean; + } + /** + * Represents a list template. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface ListTemplateLoadOptions { /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - rotationY?: number; + $all?: boolean; /** - * Specifies the z-axis rotation of the camera. + * Specifies the name of the list template. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - rotationZ?: number; + name?: boolean; /** - * Specifies the position on the z-axis for the shape. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - z?: number; + outlineNumbered?: boolean; } - /** An interface describing the data returned by calling `bibliography.toJSON()`. */ - interface BibliographyData { + /** + * Represents a footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface NoteItemLoadOptions { /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + 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; + /** + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - sources?: Word.Interfaces.SourceData[]; - /** - * Specifies the name of the active style to use for the bibliography. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - bibliographyStyle?: string; - } - /** An interface describing the data returned by calling `sourceCollection.toJSON()`. */ - interface SourceCollectionData { - items?: Word.Interfaces.SourceData[]; - } - /** An interface describing the data returned by calling `source.toJSON()`. */ - interface SourceData { - /** - * Gets if the `Source` object has been cited in the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - isCited?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the tag of the source. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - tag?: string; + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + reference?: Word.Interfaces.RangeLoadOptions; /** - * Gets the XML representation of the source. + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - xml?: string; + type?: boolean; } - /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ - interface PageSetupData { + /** + * Contains a collection of {@link Word.NoteItem} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface NoteItemCollectionLoadOptions { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + 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; + /** + * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - lineNumbering?: Word.Interfaces.LineNumberingData; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - textColumns?: Word.Interfaces.TextColumnData[]; + reference?: Word.Interfaces.RangeLoadOptions; /** - * Specifies whether Microsoft Word prints the document as a booklet. + * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - bookFoldPrinting?: boolean; + type?: boolean; + } + /** + * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface OleFormatLoadOptions { /** - * Specifies the number of pages for each booklet. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - bookFoldPrintingSheets?: number; + $all?: boolean; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bookFoldReversePrinting?: boolean; + classType?: boolean; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bottomMargin?: number; + iconIndex?: boolean; /** - * Specifies the number of characters per line in the document grid. + * Specifies the text displayed below the icon for the OLE object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - charsLine?: number; + iconLabel?: boolean; /** - * Specifies whether the first page has a different header and footer. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - differentFirstPageHeaderFooter?: boolean; + iconName?: boolean; /** - * Specifies the distance between the footer and the bottom of the page in points. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - footerDistance?: number; + iconPath?: boolean; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * Gets whether the specified object is displayed as an icon. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - gutter?: number; + isDisplayedAsIcon?: boolean; /** - * Specifies on which side the gutter appears in a document. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + isFormattingPreservedOnUpdate?: boolean; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + label?: boolean; /** - * Specifies the distance between the header and the top of the page in points. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - headerDistance?: number; + progId?: boolean; + } + /** + * Represents a page in the document. `Page` objects manage the page layout and content. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface PageLoadOptions { /** - * Specifies the layout mode for the current document. + 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; + /** + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + height?: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - leftMargin?: number; + index?: boolean; /** - * Specifies the number of lines per page in the document grid. + * Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - linesPage?: number; + width?: boolean; + } + /** + * Represents the collection of {@link Word.Page} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface PageCollectionLoadOptions { /** - * Specifies if the inside and outside margins of facing pages are the same width. + 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; + /** + * For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - mirrorMargins?: boolean; + height?: boolean; /** - * Specifies whether odd and even pages have different headers and footers. + * For EACH ITEM in the collection: Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - oddAndEvenPagesHeaderFooter?: boolean; + index?: boolean; /** - * Specifies the orientation of the page. + * For EACH ITEM in the collection: Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + width?: boolean; + } + /** + * Represents a window pane. The `Pane` object is a member of the pane collection. The pane collection includes all the window panes for a single window. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface PaneLoadOptions { /** - * Specifies the page height in points. + 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; + /** + * Returns a `Selection` object that represents the current selection in the pane. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selection?: Word.Interfaces.SelectionLoadOptions; + } + /** + * Represents the collection of {@link Word.Pane} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface PaneCollectionLoadOptions { + /** + 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; + /** + * For EACH ITEM in the collection: Returns a `Selection` object that represents the current selection in the pane. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + selection?: Word.Interfaces.SelectionLoadOptions; + } + /** + * Represents the window that displays the document. A window can be split to contain multiple reading panes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface WindowLoadOptions { + /** + 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; + /** + * Gets the active pane in the window. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activePane?: Word.Interfaces.PaneLoadOptions; + /** + * Gets the next document window in the collection of open document windows. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + next?: Word.Interfaces.WindowLoadOptions; + /** + * Gets the previous document window in the collection open document windows. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + previous?: Word.Interfaces.WindowLoadOptions; + /** + * Gets the `View` object that represents the view for the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + view?: Word.Interfaces.ViewLoadOptions; + /** + * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - pageHeight?: number; + areRulersDisplayed?: boolean; /** - * Specifies the page width in points. + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - pageWidth?: number; + areScreenTipsDisplayed?: boolean; /** - * Specifies the paper size of the page. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + areThumbnailsDisplayed?: boolean; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - rightMargin?: number; + caption?: boolean; /** - * Specifies the reading order and alignment for the specified sections. + * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + height?: boolean; /** - * Specifies the type of section break for the specified object. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + horizontalPercentScrolled?: boolean; /** - * Specifies whether to show the grid. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - showGrid?: boolean; + imeMode?: boolean; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Gets the position of an item in a collection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - suppressEndnotes?: boolean; + index?: boolean; /** - * Specifies the top margin of the page in points. + * Specifies whether the window is active. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - topMargin?: number; + isActive?: boolean; /** - * Specifies whether to print two pages per sheet. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - twoPagesOnOne?: boolean; + isDocumentMapVisible?: boolean; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; - } - /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ - interface LineNumberingData { + isEnvelopeVisible?: boolean; /** - * Specifies the numeric increment for line numbers. + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - countBy?: number; + isHorizontalScrollBarDisplayed?: boolean; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - distanceFromText?: number; + isLeftScrollBarDisplayed?: boolean; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isActive?: boolean; + isRightRulerDisplayed?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + isSplit?: boolean; /** - * Specifies the starting line number. + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - startingNumber?: number; - } - /** An interface describing the data returned by calling `textColumnCollection.toJSON()`. */ - interface TextColumnCollectionData { - items?: Word.Interfaces.TextColumnData[]; - } - /** An interface describing the data returned by calling `textColumn.toJSON()`. */ - interface TextColumnData { + isVerticalRulerDisplayed?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spaceAfter?: number; + isVerticalScrollBarDisplayed?: boolean; /** - * Specifies the width, in points, of the specified text columns. + * Specifies whether the window is visible. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: number; - } - /** - * Represents an annotation wrapper around critique displayed in the document. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface CritiqueAnnotationLoadOptions { + isVisible?: boolean; /** - 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`). + * Specifies the horizontal position of the window, measured in points. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; - /** - * Gets the range of text that is annotated. - * - * @remarks - * [Api set: WordApi 1.7] - */ - range?: Word.Interfaces.RangeLoadOptions; + left?: boolean; /** - * Gets the critique that was passed when the annotation was inserted. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.4] */ - critique?: boolean; - } - /** - * Represents an annotation attached to a paragraph. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface AnnotationLoadOptions { + showSourceDocuments?: boolean; /** - 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`). + * Specifies the vertical split percentage for the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; - /** - * Gets the `CritiqueAnnotation` object. - * - * @remarks - * [Api set: WordApi 1.7] - */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + splitVertical?: boolean; /** - * Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. + * Specifies the width of the style area in points. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.4] */ - id?: boolean; + styleAreaWidth?: boolean; /** - * Gets the state of the annotation. + * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.4] */ - state?: boolean; - } - /** - * Contains a collection of {@link Word.Annotation} objects. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface AnnotationCollectionLoadOptions { + top?: boolean; /** - 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`). + * Gets the window type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; - /** - * For EACH ITEM in the collection: Gets the `CritiqueAnnotation` object. - * - * @remarks - * [Api set: WordApi 1.7] - */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + type?: boolean; /** - * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. + * Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.4] */ - id?: boolean; + usableHeight?: boolean; /** - * For EACH ITEM in the collection: Gets the state of the annotation. + * Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.4] */ - state?: boolean; - } - /** - * Represents the `Application` object. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ApplicationLoadOptions { + usableWidth?: boolean; /** - 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`). + * Specifies the vertical scroll position as a percentage of the document length. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + verticalPercentScrolled?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; - /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - checkLanguage?: boolean; + width?: boolean; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - language?: boolean; + windowNumber?: boolean; } /** - * Represents the body of a document or a section. + * Represents the collection of {@link Word.Window} objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - interface BodyLoadOptions { + interface WindowCollectionLoadOptions { /** 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; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the active pane in the window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + activePane?: Word.Interfaces.PaneLoadOptions; /** - * Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + next?: Word.Interfaces.WindowLoadOptions; /** - * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. + * For EACH ITEM in the collection: Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - parentSection?: Word.Interfaces.SectionLoadOptions; + previous?: Word.Interfaces.WindowLoadOptions; /** - * Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; - /** - * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. - * - * @remarks - * [Api set: WordApi 1.1] - */ - style?: boolean; - /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. - * - * @remarks - * [Api set: WordApi 1.3] - */ - styleBuiltIn?: boolean; - /** - * Gets the text of the body. Use the insertText method to insert text. - * - * @remarks - * [Api set: WordApi 1.1] - */ - text?: boolean; + view?: Word.Interfaces.ViewLoadOptions; /** - * Gets the type of the body. The type can be `mainDoc`, `section`, `header`, `footer`, or `tableCell`. Additional types `footnote`, `endnote`, and `noteItem` are supported in WordApi 1.5 and later. + * For EACH ITEM in the collection: Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] - */ - type?: boolean; - } - /** - * Represents the `Border` object for text, a paragraph, or a table. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface BorderLoadOptions { - /** - 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`). + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + areRulersDisplayed?: boolean; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * For EACH ITEM in the collection: Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - color?: boolean; + areScreenTipsDisplayed?: boolean; /** - * Gets the location of the border. + * For EACH ITEM in the collection: Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - location?: boolean; + areThumbnailsDisplayed?: boolean; /** - * Specifies the border type for the border. + * For EACH ITEM in the collection: Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - type?: boolean; + caption?: boolean; /** - * Specifies whether the border is visible. + * For EACH ITEM in the collection: Specifies the height of the window (in points). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - visible?: boolean; + height?: boolean; /** - * Specifies the width for the border. + * For EACH ITEM in the collection: Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - width?: boolean; - } - /** - * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface BorderUniversalLoadOptions { - /** - 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`). + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + horizontalPercentScrolled?: boolean; /** - * Specifies the graphical page-border design for the document. + * For EACH ITEM in the collection: Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - artStyle?: boolean; + imeMode?: boolean; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * For EACH ITEM in the collection: Gets the position of an item in a collection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - artWidth?: boolean; + index?: boolean; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Specifies whether the window is active. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - color?: boolean; + isActive?: boolean; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * For EACH ITEM in the collection: Specifies whether the document map is visible. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - colorIndex?: boolean; + isDocumentMapVisible?: boolean; /** - * Returns `true` if an inside border can be applied to the specified object. + * For EACH ITEM in the collection: Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - inside?: boolean; + isEnvelopeVisible?: boolean; /** - * Specifies whether the border is visible. + * For EACH ITEM in the collection: Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isVisible?: boolean; + isHorizontalScrollBarDisplayed?: boolean; /** - * Specifies the line style of the border. + * For EACH ITEM in the collection: Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - lineStyle?: boolean; + isLeftScrollBarDisplayed?: boolean; /** - * Specifies the line width of an object's border. + * For EACH ITEM in the collection: Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - lineWidth?: boolean; - } - /** - * Represents the collection of border styles. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface BorderCollectionLoadOptions { + isRightRulerDisplayed?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies whether the window is split into multiple panes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + isSplit?: boolean; /** - * For EACH ITEM in the collection: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * For EACH ITEM in the collection: Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - color?: boolean; + isVerticalRulerDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets the location of the border. + * For EACH ITEM in the collection: Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - location?: boolean; + isVerticalScrollBarDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies the border type for the border. + * For EACH ITEM in the collection: Specifies whether the window is visible. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - type?: boolean; + isVisible?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * For EACH ITEM in the collection: Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - visible?: boolean; + left?: boolean; /** - * For EACH ITEM in the collection: Specifies the width for the border. + * For EACH ITEM in the collection: Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - width?: boolean; - } - /** - * Represents the collection of {@link Word.BorderUniversal} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface BorderUniversalCollectionLoadOptions { + showSourceDocuments?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies the vertical split percentage for the window. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + splitVertical?: boolean; /** - * For EACH ITEM in the collection: Specifies the graphical page-border design for the document. + * For EACH ITEM in the collection: Specifies the width of the style area in points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - artStyle?: boolean; + styleAreaWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * For EACH ITEM in the collection: Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - artWidth?: boolean; + top?: boolean; /** - * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Gets the window type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - color?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * For EACH ITEM in the collection: Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - colorIndex?: boolean; + usableHeight?: boolean; /** - * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. + * For EACH ITEM in the collection: Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - inside?: boolean; + usableWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * For EACH ITEM in the collection: Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isVisible?: boolean; + verticalPercentScrolled?: boolean; /** - * For EACH ITEM in the collection: Specifies the line style of the border. + * For EACH ITEM in the collection: Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - lineStyle?: boolean; + width?: boolean; /** - * For EACH ITEM in the collection: Specifies the line width of an object's border. + * For EACH ITEM in the collection: Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - lineWidth?: boolean; + windowNumber?: boolean; } /** - * Represents a break in a Word document. This could be a page, column, or section break. + * Represents a single paragraph in a selection, range, content control, or document body. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - interface BreakLoadOptions { + interface ParagraphLoadOptions { /** 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; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - range?: Word.Interfaces.RangeLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * Returns the page number on which the break occurs. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pageIndex?: boolean; - } - /** - * Contains a collection of {@link Word.Break} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface BreakCollectionLoadOptions { + * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + list?: Word.Interfaces.ListLoadOptions; /** - 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; + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listItem?: Word.Interfaces.ListItemLoadOptions; /** - * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the break. + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - range?: Word.Interfaces.RangeLoadOptions; + listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * For EACH ITEM in the collection: Returns the page number on which the break occurs. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pageIndex?: boolean; - } - /** - * Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface BuildingBlockLoadOptions { + * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - 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; + * Gets the parent body of the paragraph. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `BuildingBlockCategory` object that represents the category for the building block. + * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. + * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + /** + * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTable?: Word.Interfaces.TableLoadOptions; + /** + * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCell?: Word.Interfaces.TableCellLoadOptions; + /** + * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + /** + * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApiDesktop 1.3] */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the description for the building block. + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - description?: boolean; + alignment?: boolean; /** - * Returns the internal identification number for the building block. + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - id?: boolean; + firstLineIndent?: boolean; /** - * Returns the position of this building block in a collection. + * Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - index?: boolean; + isLastParagraph?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - insertType?: boolean; + isListItem?: boolean; /** - * Specifies the name of the building block. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - name?: boolean; + leftIndent?: boolean; /** - * Specifies the contents of the building block. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - value?: boolean; - } - /** - * Represents a category of building blocks in a Word document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface BuildingBlockCategoryLoadOptions { + lineSpacing?: boolean; /** - 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`). + * Specifies the amount of spacing, in grid lines, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + lineUnitAfter?: boolean; /** - * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + * Specifies the amount of spacing, in grid lines, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitBefore?: boolean; /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - index?: boolean; + outlineLevel?: boolean; /** - * Returns the name of the `BuildingBlockCategory` object. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - name?: boolean; - } - /** - * Represents a type of building block in a Word document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface BuildingBlockTypeItemLoadOptions { + rightIndent?: boolean; /** - 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`). + * Specifies the spacing, in points, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + spaceAfter?: boolean; /** - * Returns the position of an item in a collection. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - index?: boolean; + spaceBefore?: boolean; /** - * Returns the localized name of a building block type. + * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - name?: boolean; - } - /** - * The data specific to content controls of type CheckBox. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface CheckboxContentControlLoadOptions { + style?: boolean; /** - 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`). + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + styleBuiltIn?: boolean; /** - * Specifies the current state of the checkbox. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - isChecked?: boolean; + tableNestingLevel?: boolean; + /** + * Gets the text of the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; + /** + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * + * @remarks + * [Api set: WordApi 1.6] + */ + uniqueLocalId?: boolean; } /** - * Represents a comment in the document. + * Contains a collection of {@link Word.Paragraph} objects. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - interface CommentLoadOptions { + interface ParagraphCollectionLoadOptions { /** 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; /** - * Specifies the comment's content range. + * For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * Gets the email of the comment's author. + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + list?: Word.Interfaces.ListLoadOptions; + /** + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listItem?: Word.Interfaces.ListItemLoadOptions; + /** + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; + /** + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listOrNullObject?: Word.Interfaces.ListLoadOptions; + /** + * For EACH ITEM in the collection: Gets the parent body of the paragraph. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentBody?: Word.Interfaces.BodyLoadOptions; + /** + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + /** + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCell?: Word.Interfaces.TableCellLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorEmail?: boolean; + alignment?: boolean; /** - * Gets the name of the comment's author. + * For EACH ITEM in the collection: Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + firstLineIndent?: boolean; /** - * Specifies the comment's content as plain text. + * For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - content?: boolean; + isLastParagraph?: boolean; /** - * Gets the creation date of the comment. + * For EACH ITEM in the collection: Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - creationDate?: boolean; + isListItem?: boolean; /** - * Gets the ID of the comment. + * For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: boolean; + leftIndent?: boolean; /** - * Specifies the comment thread's status. Setting to `true` resolves the comment thread. Getting a value of `true` means that the comment thread is resolved. + * For EACH ITEM in the collection: Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - resolved?: boolean; - } - /** - * Contains a collection of {@link Word.Comment} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentCollectionLoadOptions { + lineSpacing?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + lineUnitAfter?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitBefore?: boolean; + /** + * For EACH ITEM in the collection: Specifies the outline level for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + outlineLevel?: boolean; + /** + * For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + rightIndent?: boolean; + /** + * For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceAfter?: boolean; /** - * For EACH ITEM in the collection: Gets the email of the comment's author. + * For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorEmail?: boolean; + spaceBefore?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the comment's author. + * For EACH ITEM in the collection: Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + style?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment's content as plain text. + * For EACH ITEM in the collection: Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - content?: boolean; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Gets the creation date of the comment. + * For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - creationDate?: boolean; + tableNestingLevel?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the comment. + * For EACH ITEM in the collection: Gets the text of the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to `true` resolves the comment thread. Getting a value of `true` means that the comment thread is resolved. + * For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.6] */ - resolved?: boolean; + uniqueLocalId?: boolean; } /** + * Represents a style of paragraph in a document. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - interface CommentContentRangeLoadOptions { + interface ParagraphFormatLoadOptions { /** 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; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - bold?: boolean; + alignment?: boolean; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - hyperlink?: boolean; + firstLineIndent?: boolean; /** - * Checks whether the range length is zero. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - isEmpty?: boolean; + keepTogether?: boolean; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - italic?: boolean; + keepWithNext?: boolean; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Specifies the left indent. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - strikeThrough?: boolean; + leftIndent?: boolean; /** - * Gets the text of the comment range. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - text?: boolean; + lineSpacing?: boolean; /** - * Specifies a value that indicates the comment text's underline type. `none` if the comment text isn't underlined. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - underline?: boolean; - } - /** - * Represents a comment reply in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentReplyLoadOptions { + lineUnitAfter?: boolean; /** - 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`). + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] */ - $all?: boolean; - /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + lineUnitBefore?: boolean; /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentComment?: Word.Interfaces.CommentLoadOptions; + * Specifies whether left and right indents are the same width. + * + * @remarks + * [Api set: WordApi 1.5] + */ + mirrorIndents?: boolean; /** - * Gets the email of the comment reply's author. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - authorEmail?: boolean; + outlineLevel?: boolean; /** - * Gets the name of the comment reply's author. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - authorName?: boolean; + rightIndent?: boolean; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - content?: boolean; + spaceAfter?: boolean; /** - * Gets the creation date of the comment reply. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - creationDate?: boolean; + spaceBefore?: boolean; /** - * Gets the ID of the comment reply. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - id?: boolean; + widowControl?: boolean; } /** - * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. + * Represents a contiguous area in a document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - interface CommentReplyCollectionLoadOptions { + interface RangeLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Specifies the commentReply's content range. + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent comment of this reply. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the email of the comment reply's author. - * - * @remarks - * [Api set: WordApi 1.4] - */ - authorEmail?: boolean; + * Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the name of the comment reply's author. - * - * @remarks - * [Api set: WordApi 1.4] - */ - authorName?: boolean; + * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. - * - * @remarks - * [Api set: WordApi 1.4] - */ - content?: boolean; + * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the creation date of the comment reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ - creationDate?: boolean; + * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the ID of the comment reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ - id?: boolean; - } - /** - * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface XmlMappingLoadOptions { + * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - 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; + * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isMapped?: boolean; + bold?: boolean; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - prefixMappings?: boolean; + boldBidirectional?: boolean; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - xpath?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface CustomXmlPrefixMappingCollectionLoadOptions { + case?: boolean; /** - 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`). + * Specifies the character width of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + characterWidth?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - namespaceUri?: boolean; + combineCharacters?: boolean; /** - * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - prefix?: boolean; - } - /** - * Represents a `CustomXmlPrefixMapping` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface CustomXmlPrefixMappingLoadOptions { + disableCharacterSpaceGrid?: boolean; /** - 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`). + * Specifies the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + emphasisMark?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Specifies the ending character position of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - namespaceUri?: boolean; + end?: boolean; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - prefix?: boolean; - } - /** - * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface CustomXmlSchemaLoadOptions { + fitTextWidth?: boolean; /** - 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`). + * Specifies if a grammar check has been run on the range or document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + grammarChecked?: boolean; /** - * Gets the location of the schema on a computer. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - location?: boolean; + hasNoProofing?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - namespaceUri?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface CustomXmlSchemaCollectionLoadOptions { + highlightColorIndex?: boolean; /** - 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`). + * Specifies the formatting for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + horizontalInVertical?: boolean; /** - * For EACH ITEM in the collection: Gets the location of the schema on a computer. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - location?: boolean; + hyperlink?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Specifies the ID for the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - namespaceUri?: boolean; - } - /** - * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface CustomXmlNodeCollectionLoadOptions { + id?: boolean; /** - 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`). + * Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; - /** - * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * For EACH ITEM in the collection: Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; + isEmpty?: boolean; /** - * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + * Gets if the range is collapsed and is located at the end-of-row mark in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isEndOfRowMark?: boolean; /** - * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + * Gets whether the text in the range is visible on the screen. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isTextVisibleOnScreen?: boolean; /** - * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. + * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - baseName?: boolean; + italic?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - namespaceUri?: boolean; + italicBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets the type of the current node. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nodeType?: boolean; + kana?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the current node. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - nodeValue?: boolean; + languageDetected?: boolean; /** - * For EACH ITEM in the collection: Specifies the text for the current node. + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - text?: boolean; + languageId?: boolean; /** - * For EACH ITEM in the collection: Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xpath?: boolean; + languageIdFarEast?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xml?: boolean; - } - /** - * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface CustomXmlNodeLoadOptions { + languageIdOther?: boolean; /** - 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`). + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; - /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + showAll?: boolean; /** - * Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; - /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + * Specifies if spelling has been checked throughout the range or document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + spellingChecked?: boolean; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - baseName?: boolean; + start?: boolean; /** - * Gets the unique address identifier for the namespace of the node. + * Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - namespaceUri?: boolean; + storyLength?: boolean; /** - * Gets the type of the current node. + * Gets the story type for the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nodeType?: boolean; + storyType?: boolean; /** - * Specifies the value of the current node. + * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - nodeValue?: boolean; + style?: boolean; /** - * Specifies the text for the current node. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - text?: boolean; + styleBuiltIn?: boolean; /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Gets the text of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - xpath?: boolean; + text?: boolean; /** - * Gets the XML representation of the current node and its children. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - xml?: boolean; + twoLinesInOne?: boolean; } /** - * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. + * Contains a collection of {@link Word.Range} objects. * * @remarks * [Api set: WordApi 1.1] */ - interface ContentControlLoadOptions { + interface RangeCollectionLoadOptions { /** 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; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; - /** - * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; - /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; - /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * Gets the parent body of the content control. + * For EACH ITEM in the collection: Gets the parent body of the range. * * @remarks * [Api set: WordApi 1.3] */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks * [Api set: WordApi 1.1] */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks * [Api set: WordApi 1.3] */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; - /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; - /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the appearance of the content control. The value can be `boundingBox`, `tags`, or `hidden`. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - appearance?: boolean; + bold?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - cannotDelete?: boolean; + boldBidirectional?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * For EACH ITEM in the collection: Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - cannotEdit?: boolean; + case?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * For EACH ITEM in the collection: Specifies the character width of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - color?: boolean; + characterWidth?: boolean; /** - * Gets an integer that represents the content control identifier. + * For EACH ITEM in the collection: Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - id?: boolean; + combineCharacters?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * For EACH ITEM in the collection: Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - placeholderText?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. + * For EACH ITEM in the collection: Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - removeWhenEdited?: boolean; + emphasisMark?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the `styleBuiltIn` property. + * For EACH ITEM in the collection: Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - style?: boolean; + end?: boolean; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the `style` property. + * For EACH ITEM in the collection: Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleBuiltIn?: boolean; + fitTextWidth?: boolean; /** - * Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. + * For EACH ITEM in the collection: Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - subtype?: boolean; + grammarChecked?: boolean; /** - * Specifies a tag to identify a content control. + * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - tag?: boolean; + hasNoProofing?: boolean; /** - * Gets the text of the content control. + * For EACH ITEM in the collection: Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - text?: boolean; + highlightColorIndex?: boolean; /** - * Specifies the title for a content control. + * For EACH ITEM in the collection: Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - title?: boolean; + horizontalInVertical?: boolean; /** - * Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. + * For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - type?: boolean; - } - /** - * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface ContentControlCollectionLoadOptions { + hyperlink?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies the ID for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; - /** - * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; - /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; - /** - * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + id?: boolean; /** - * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontLoadOptions; + * For EACH ITEM in the collection: Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isEmpty?: boolean; /** - * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; + * For EACH ITEM in the collection: Gets if the range is collapsed and is located at the end-of-row mark in a table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isEndOfRowMark?: boolean; /** - * For EACH ITEM in the collection: Gets the parent body of the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; + * For EACH ITEM in the collection: Gets whether the text in the range is visible on the screen. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isTextVisibleOnScreen?: boolean; /** - * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + italic?: boolean; /** - * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic (right-to-left languages). + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + italicBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTable?: Word.Interfaces.TableLoadOptions; + * For EACH ITEM in the collection: Specifies whether the range of Japanese language text is hiragana or katakana. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + kana?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageDetected?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageId?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + * For EACH ITEM in the collection: Specifies an East Asian language for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageIdFarEast?: boolean; /** - * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + * For EACH ITEM in the collection: Specifies a language for the range that isn't classified as an East Asian language. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + languageIdOther?: boolean; /** - * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + * For EACH ITEM in the collection: Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + showAll?: boolean; /** - * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + * For EACH ITEM in the collection: Specifies if spelling has been checked throughout the range or document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + spellingChecked?: boolean; /** - * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be `boundingBox`, `tags`, or `hidden`. + * For EACH ITEM in the collection: Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - appearance?: boolean; + start?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. + * For EACH ITEM in the collection: Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - cannotDelete?: boolean; + storyLength?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. + * For EACH ITEM in the collection: Gets the story type for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - cannotEdit?: boolean; + storyType?: boolean; /** - * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * For EACH ITEM in the collection: Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks * [Api set: WordApi 1.1] */ - color?: boolean; + style?: boolean; /** - * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * For EACH ITEM in the collection: Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - id?: boolean; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * For EACH ITEM in the collection: Gets the text of the range. * * @remarks * [Api set: WordApi 1.1] */ - placeholderText?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. + * For EACH ITEM in the collection: Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - removeWhenEdited?: boolean; + twoLinesInOne?: boolean; + } + /** + * Specifies the options to be included in a search operation. + To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface SearchOptionsLoadOptions { /** - * For EACH ITEM in the collection: Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the `styleBuiltIn` property. + 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; + /** + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ - style?: boolean; + ignorePunct?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the `style` property. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - styleBuiltIn?: boolean; + ignoreSpace?: boolean; /** - * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subtype?: boolean; + matchCase?: boolean; /** - * For EACH ITEM in the collection: Specifies a tag to identify a content control. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ - tag?: boolean; + matchPrefix?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the content control. + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ - text?: boolean; + matchSuffix?: boolean; /** - * For EACH ITEM in the collection: Specifies the title for a content control. + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ - title?: boolean; + matchWholeWord?: boolean; /** - * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ - type?: boolean; + matchWildcards?: boolean; } /** - * Represents a list item in a dropdown list or combo box content control. + * Represents a section in a Word document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.1] */ - interface ContentControlListItemLoadOptions { + interface SectionLoadOptions { /** 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; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ + body?: Word.Interfaces.BodyLoadOptions; + /** + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageSetup?: Word.Interfaces.PageSetupLoadOptions; + /** + * Specifies if the section is protected for forms. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.3] */ - displayText?: boolean; + protectedForForms?: boolean; + } + /** + * Contains the collection of the document's {@link Word.Section} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface SectionCollectionLoadOptions { /** - * Specifies the index location of a content control list item in the collection of list items. - * - * @remarks - * [Api set: WordApi 1.9] + 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`). */ - index?: boolean; + $all?: boolean; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * For EACH ITEM in the collection: Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ + body?: Word.Interfaces.BodyLoadOptions; + /** + * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + pageSetup?: Word.Interfaces.PageSetupLoadOptions; + /** + * For EACH ITEM in the collection: Specifies if the section is protected for forms. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.3] */ - value?: boolean; + protectedForForms?: boolean; } /** - * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * Represents a setting of the add-in. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.4] */ - interface ContentControlListItemCollectionLoadOptions { + interface SettingLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control. + * Gets the key of the setting. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.4] */ - displayText?: boolean; + key?: boolean; /** - * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.4] */ - index?: boolean; + value?: boolean; + } + /** + * Contains the collection of {@link Word.Setting} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface SettingCollectionLoadOptions { /** - * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + 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; + /** + * For EACH ITEM in the collection: Gets the key of the setting. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.4] + */ + key?: boolean; + /** + * For EACH ITEM in the collection: Specifies the value of the setting. + * + * @remarks + * [Api set: WordApi 1.4] */ value?: boolean; } /** - * Represents a custom property. + * Contains a collection of {@link Word.Style} objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - interface CustomPropertyLoadOptions { + interface StyleCollectionLoadOptions { + /** + 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; + /** + * For EACH ITEM in the collection: Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + borders?: Word.Interfaces.BorderCollectionLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + font?: Word.Interfaces.FontLoadOptions; + /** + * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + frame?: Word.Interfaces.FrameLoadOptions; + /** + * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + linkStyle?: Word.Interfaces.StyleLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `ListTemplate` object that represents the list formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * + * @remarks + * [Api set: WordApi 1.6] + */ + shading?: Word.Interfaces.ShadingLoadOptions; /** - 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; + * For EACH ITEM in the collection: Gets a `TableStyle` object representing style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ + tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** - * Gets the key of the custom property. + * For EACH ITEM in the collection: Specifies whether the style is automatically redefined based on the selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - key?: boolean; + automaticallyUpdate?: boolean; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.3] - */ - type?: boolean; - /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * [Api set: WordApi 1.5] * - * @remarks - * [Api set: WordApi 1.3] - */ - value?: boolean; - } - /** - * Contains the collection of {@link Word.CustomProperty} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface CustomPropertyCollectionLoadOptions { - /** - 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`). + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - $all?: boolean; + baseStyle?: boolean; /** - * For EACH ITEM in the collection: Gets the key of the custom property. + * For EACH ITEM in the collection: Gets whether the style is a built-in style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - key?: boolean; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * For EACH ITEM in the collection: Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - type?: boolean; + hasProofing?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * For EACH ITEM in the collection: Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi 1.3] - */ - value?: boolean; - } - /** - * Represents a custom XML part. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CustomXmlPartLoadOptions { - /** - 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`). + * [Api set: WordApi 1.5] */ - $all?: boolean; - /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + inUse?: boolean; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - builtIn?: boolean; + languageId?: boolean; /** - * Gets the ID of the custom XML part. + * For EACH ITEM in the collection: Specifies an East Asian language for the style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.3] */ - id?: boolean; + languageIdFarEast?: boolean; /** - * Gets the namespace URI of the custom XML part. + * For EACH ITEM in the collection: Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - namespaceUri?: boolean; + linked?: boolean; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * For EACH ITEM in the collection: Returns the list level for the style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CustomXmlPartCollectionLoadOptions { - /** - 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; - /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + listLevelNumber?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * For EACH ITEM in the collection: Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApiDesktop 1.3] */ - builtIn?: boolean; + locked?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * For EACH ITEM in the collection: Gets the name of the style in the language of the user. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - id?: boolean; + nameLocal?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - namespaceUri?: boolean; + nextParagraphStyle?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * For EACH ITEM in the collection: Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CustomXmlPartScopedCollectionLoadOptions { + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies the priority. + * + * @remarks + * [Api set: WordApi 1.5] */ - $all?: boolean; - /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + priority?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - builtIn?: boolean; + quickStyle?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * For EACH ITEM in the collection: Gets the style type. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - id?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * For EACH ITEM in the collection: Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - namespaceUri?: boolean; + unhideWhenUsed?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * For EACH ITEM in the collection: Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - xml?: boolean; + visibility?: boolean; } /** - * The `Document` object is the top level object. A `Document` object contains one or more sections, content controls, and the body that contains the contents of the document. + * Represents a style in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - interface DocumentLoadOptions { + interface StyleLoadOptions { /** 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; /** - * Specifies a `Template` object that represents the template attached to the document. + * Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + borders?: Word.Interfaces.BorderCollectionLoadOptions; + /** + * Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + font?: Word.Interfaces.FontLoadOptions; + /** + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - attachedTemplate?: Word.Interfaces.TemplateLoadOptions; + frame?: Word.Interfaces.FrameLoadOptions; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Gets a `ListTemplate` object that represents the list formatting for the style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - body?: Word.Interfaces.BodyLoadOptions; + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * Returns a `PageSetup` object that's associated with the document. + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * Gets the properties of the document. + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + shading?: Word.Interfaces.ShadingLoadOptions; /** - * Specifies if automatic hyphenation is turned on for the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - autoHyphenation?: boolean; + * Gets a `TableStyle` object representing style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ + tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** - * Specifies if the edits in the document are automatically saved. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - autoSaveOn?: boolean; + automaticallyUpdate?: boolean; /** - * Specifies the ChangeTracking mode. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.4] - */ - changeTrackingMode?: boolean; - /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * [Api set: WordApi 1.5] * - * @remarks - * [Api set: WordApiDesktop 1.3] + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - consecutiveHyphensLimit?: boolean; + baseStyle?: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Gets whether the style is a built-in style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.5] */ - hyphenateCaps?: boolean; + builtIn?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - languageDetected?: boolean; + hasProofing?: boolean; /** - * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. + * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi 1.1] - */ - saved?: boolean; - } - /** - * The `DocumentCreated` object is the top level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface DocumentCreatedLoadOptions { - /** - 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`). + * [Api set: WordApi 1.5] */ - $all?: boolean; - /** - * Gets the `Body` object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - body?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + inUse?: boolean; /** - * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - saved?: boolean; - } - /** - * Represents document properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface DocumentPropertiesLoadOptions { - /** - 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`). + * [Api set: WordApiDesktop 1.3] */ - $all?: boolean; + languageId?: boolean; /** - * Gets the application name of the document. + * Specifies an East Asian language for the style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - applicationName?: boolean; + languageIdFarEast?: boolean; /** - * Specifies the author of the document. + * Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - author?: boolean; + linked?: boolean; /** - * Specifies the category of the document. + * Returns the list level for the style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - category?: boolean; + listLevelNumber?: boolean; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Specifies whether the style cannot be changed or edited. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - comments?: boolean; + locked?: boolean; /** - * Specifies the company of the document. + * Gets the name of the style in the language of the user. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - company?: boolean; + nameLocal?: boolean; /** - * Gets the creation date of the document. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks - * [Api set: WordApi 1.3] - */ - creationDate?: boolean; - /** - * Specifies the format of the document. + * [Api set: WordApi 1.5] * - * @remarks - * [Api set: WordApi 1.3] + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - format?: boolean; + nextParagraphStyle?: boolean; /** - * Specifies the keywords of the document. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - keywords?: boolean; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Gets the last author of the document. + * Specifies the priority. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - lastAuthor?: boolean; + priority?: boolean; /** - * Gets the last print date of the document. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - lastPrintDate?: boolean; + quickStyle?: boolean; /** - * Gets the last save time of the document. + * Gets the style type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - lastSaveTime?: boolean; + type?: boolean; /** - * Specifies the manager of the document. + * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - manager?: boolean; + unhideWhenUsed?: boolean; /** - * Gets the revision number of the document. + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - revisionNumber?: boolean; + visibility?: boolean; + } + /** + * Represents the `Shading` object. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface ShadingLoadOptions { /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. - * - * @remarks - * [Api set: WordApi 1.3] + 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`). */ - security?: boolean; + $all?: boolean; /** - * Specifies the subject of the document. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - subject?: boolean; + backgroundPatternColor?: boolean; /** - * Gets the template of the document. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - template?: boolean; + foregroundPatternColor?: boolean; /** - * Specifies the title of the document. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - title?: boolean; + texture?: boolean; } /** - * Represents a field. + * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. * * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + * [Api set: WordApiDesktop 1.3] */ - interface FieldLoadOptions { + interface ShadingUniversalLoadOptions { /** 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; /** - * Gets the parent body of the field. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; - /** - * Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; - /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentTable?: Word.Interfaces.TableLoadOptions; - /** - * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; - /** - * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; - /** - * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; - /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ - result?: Word.Interfaces.RangeLoadOptions; - /** - * Specifies the field's code instruction. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. - */ - code?: boolean; - /** - * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - data?: boolean; + backgroundPatternColor?: boolean; /** - * Gets the field's kind. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - kind?: boolean; + backgroundPatternColorIndex?: boolean; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - locked?: boolean; + foregroundPatternColor?: boolean; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.3] */ - showCodes?: boolean; + foregroundPatternColorIndex?: boolean; /** - * Gets the field's type. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - type?: boolean; + texture?: boolean; } /** - * Contains a collection of {@link Word.Field} objects. + * Represents a table in a Word document. * * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + * [Api set: WordApi 1.3] */ - interface FieldCollectionLoadOptions { + interface TableLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Gets the parent body of the field. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] + */ + font?: Word.Interfaces.FontLoadOptions; + /** + * Gets the parent body of the table. + * + * @remarks + * [Api set: WordApi 1.3] */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the field's result data. + * Returns the `ShadingUniversal` object that represents the shading of the table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - result?: Word.Interfaces.RangeLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Specifies the field's code instruction. + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] + */ + alignment?: boolean; + /** + * Specifies the description of the table. * - * Note: The ability to set the code was introduced in WordApi 1.5. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - code?: boolean; + description?: boolean; /** - * For EACH ITEM in the collection: Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - data?: boolean; + headerRowCount?: boolean; /** - * For EACH ITEM in the collection: Gets the field's kind. + * Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - kind?: boolean; + horizontalAlignment?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - locked?: boolean; + isUniform?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - showCodes?: boolean; + nestingLevel?: boolean; /** - * For EACH ITEM in the collection: Gets the field's type. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: boolean; + rowCount?: boolean; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: boolean; + /** + * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + style?: boolean; + /** + * Specifies whether the table has banded columns. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedColumns?: boolean; + /** + * Specifies whether the table has banded rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedRows?: boolean; + /** + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * Specifies whether the table has a first column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleFirstColumn?: boolean; + /** + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleLastColumn?: boolean; + /** + * Specifies whether the table has a total (last) row with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleTotalRow?: boolean; + /** + * Specifies the title of the table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + title?: boolean; + /** + * Specifies the text values in the table, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: boolean; + /** + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: boolean; + /** + * Specifies the width of the table in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: boolean; } /** - * Represents a font. + * Represents the `TableStyle` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - interface FontLoadOptions { + interface TableStyleLoadOptions { /** 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; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - fill?: Word.Interfaces.FillFormatLoadOptions; - /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - glow?: Word.Interfaces.GlowFormatLoadOptions; - /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - line?: Word.Interfaces.LineFormatLoadOptions; - /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - reflection?: Word.Interfaces.ReflectionFormatLoadOptions; - /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - textColor?: Word.Interfaces.ColorFormatLoadOptions; - /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - textShadow?: Word.Interfaces.ShadowFormatLoadOptions; - /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatLoadOptions; + shading?: Word.Interfaces.ShadingLoadOptions; /** - * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - allCaps?: boolean; + alignment?: boolean; /** - * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - bold?: boolean; + allowBreakAcrossPage?: boolean; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - boldBidirectional?: boolean; + bottomCellMargin?: boolean; /** - * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - color?: boolean; + cellSpacing?: boolean; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - colorIndex?: boolean; + columnStripe?: boolean; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - colorIndexBidirectional?: boolean; + isBreakAcrossPagesAllowed?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - contextualAlternates?: boolean; + leftCellMargin?: boolean; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - diacriticColor?: boolean; + leftIndent?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - disableCharacterSpaceGrid?: boolean; + rightCellMargin?: boolean; /** - * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - doubleStrikeThrough?: boolean; + rowStripe?: boolean; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - emboss?: boolean; + tableDirection?: boolean; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - emphasisMark?: boolean; + topCellMargin?: boolean; + } + /** + * Represents a tab stop in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TabStopLoadOptions { /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - engrave?: boolean; + $all?: boolean; /** - * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. + * Gets the next tab stop in the collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + next?: Word.Interfaces.TabStopLoadOptions; + /** + * Gets the previous tab stop in the collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + previous?: Word.Interfaces.TabStopLoadOptions; + /** + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - hidden?: boolean; + alignment?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to `null`. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Gets whether this tab stop is a custom tab stop. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - highlightColor?: boolean; + customTab?: boolean; /** - * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - italic?: boolean; + leader?: boolean; /** - * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. + * Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - italicBidirectional?: boolean; + position?: boolean; + } + /** + * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TabStopCollectionLoadOptions { /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + 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; + /** + * For EACH ITEM in the collection: Gets the next tab stop in the collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + next?: Word.Interfaces.TabStopLoadOptions; + /** + * For EACH ITEM in the collection: Gets the previous tab stop in the collection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + previous?: Word.Interfaces.TabStopLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - kerning?: boolean; + alignment?: boolean; /** - * Specifies the ligature setting for the `Font` object. + * For EACH ITEM in the collection: Gets whether this tab stop is a custom tab stop. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - ligature?: boolean; + customTab?: boolean; /** - * Specifies the name of the font. + * For EACH ITEM in the collection: Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - name?: boolean; + leader?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * For EACH ITEM in the collection: Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nameAscii?: boolean; + position?: boolean; + } + /** + * Contains the collection of the document's {@link Word.Table} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface TableCollectionLoadOptions { /** - * Specifies the font name in a right-to-left language document. + 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; + /** + * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + font?: Word.Interfaces.FontLoadOptions; + /** + * For EACH ITEM in the collection: Gets the parent body of the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentBody?: Word.Interfaces.BodyLoadOptions; + /** + * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + /** + * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCell?: Word.Interfaces.TableCellLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - nameBidirectional?: boolean; + alignment?: boolean; /** - * Specifies the East Asian font name. + * For EACH ITEM in the collection: Specifies the description of the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nameFarEast?: boolean; + description?: boolean; /** - * Specifies the font used for characters with codes from 128 through 255. + * For EACH ITEM in the collection: Specifies the number of header rows. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - nameOther?: boolean; + headerRowCount?: boolean; /** - * Specifies the number form setting for an OpenType font. + * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - numberForm?: boolean; + horizontalAlignment?: boolean; /** - * Specifies the number spacing setting for the font. + * For EACH ITEM in the collection: Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - numberSpacing?: boolean; + isUniform?: boolean; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * For EACH ITEM in the collection: Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - outline?: boolean; + nestingLevel?: boolean; /** - * Specifies the position of text (in points) relative to the base line. + * For EACH ITEM in the collection: Gets the number of rows in the table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - position?: boolean; + rowCount?: boolean; /** - * Specifies the scaling percentage applied to the font. + * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - scaling?: boolean; + shadingColor?: boolean; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * For EACH ITEM in the collection: Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - shadow?: boolean; + style?: boolean; /** - * Specifies the font size in points. + * For EACH ITEM in the collection: Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - size?: boolean; + styleBandedColumns?: boolean; /** - * Specifies the font size in points for right-to-left text. + * For EACH ITEM in the collection: Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - sizeBidirectional?: boolean; + styleBandedRows?: boolean; /** - * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * For EACH ITEM in the collection: Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - smallCaps?: boolean; + styleBuiltIn?: boolean; /** - * Specifies the spacing between characters. + * For EACH ITEM in the collection: Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - spacing?: boolean; + styleFirstColumn?: boolean; /** - * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. + * For EACH ITEM in the collection: Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - strikeThrough?: boolean; + styleLastColumn?: boolean; /** - * Specifies the stylistic set for the font. + * For EACH ITEM in the collection: Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - stylisticSet?: boolean; + styleTotalRow?: boolean; /** - * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. + * For EACH ITEM in the collection: Specifies the title of the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - subscript?: boolean; + title?: boolean; /** - * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. + * For EACH ITEM in the collection: Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - superscript?: boolean; + values?: boolean; /** - * Specifies the font's underline type. `none` if the font isn't underlined. + * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - underline?: boolean; + verticalAlignment?: boolean; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Specifies the width of the table in points. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - underlineColor?: boolean; + width?: boolean; } /** - * Represents a hyperlink in a Word document. + * Represents a table column in a Word document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface HyperlinkLoadOptions { + interface TableColumnLoadOptions { /** 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; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * Specifies the address (for example, a file name or URL) of the hyperlink. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - address?: boolean; - /** - * Specifies the text string for the hyperlink's subject line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - emailSubject?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isExtraInfoRequired?: boolean; + columnIndex?: boolean; /** - * Returns the name of the `Hyperlink` object. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ - name?: boolean; + isFirst?: boolean; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ - screenTip?: boolean; + isLast?: boolean; /** - * Specifies a named location in the destination of the hyperlink. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - subAddress?: boolean; + nestingLevel?: boolean; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApiDesktop 1.3] */ - target?: boolean; + preferredWidth?: boolean; /** - * Specifies the hyperlink's visible text in the document. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textToDisplay?: boolean; + preferredWidthType?: boolean; /** - * Returns the hyperlink type. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - type?: boolean; + width?: boolean; } /** - * Contains a collection of {@link Word.Hyperlink} objects. + * Represents a collection of {@link Word.TableColumn} objects in a Word document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface HyperlinkCollectionLoadOptions { + interface TableColumnCollectionLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - address?: boolean; - /** - * For EACH ITEM in the collection: Specifies the text string for the hyperlink's subject line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - emailSubject?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Returns `true` if extra information is required to resolve the hyperlink. + * For EACH ITEM in the collection: Returns the position of this column in a collection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isExtraInfoRequired?: boolean; + columnIndex?: boolean; /** - * For EACH ITEM in the collection: Returns the name of the `Hyperlink` object. + * For EACH ITEM in the collection: Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ - name?: boolean; + isFirst?: boolean; /** - * For EACH ITEM in the collection: Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * For EACH ITEM in the collection: Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ - screenTip?: boolean; + isLast?: boolean; /** - * For EACH ITEM in the collection: Specifies a named location in the destination of the hyperlink. + * For EACH ITEM in the collection: Returns the nesting level of the column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - subAddress?: boolean; + nestingLevel?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the frame or window in which to load the hyperlink. + * For EACH ITEM in the collection: Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApiDesktop 1.3] */ - target?: boolean; + preferredWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the hyperlink's visible text in the document. + * For EACH ITEM in the collection: Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textToDisplay?: boolean; + preferredWidthType?: boolean; /** - * For EACH ITEM in the collection: Returns the hyperlink type. + * For EACH ITEM in the collection: Specifies the width of the column, in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - type?: boolean; + width?: boolean; } /** - * Represents an inline picture. + * Represents a table of authorities in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - interface InlinePictureLoadOptions { + interface TableOfAuthoritiesLoadOptions { /** 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; /** - * Gets the parent paragraph that contains the inline image. - * - * @remarks - * [Api set: WordApi 1.2] - */ - paragraph?: Word.Interfaces.ParagraphLoadOptions; - /** - * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; - /** - * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTable?: Word.Interfaces.TableLoadOptions; + * Specifies the name of the bookmark from which to collect table of authorities entries. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bookmark?: boolean; /** - * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + * 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + category?: boolean; /** - * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + entrySeparator?: boolean; /** - * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + * Specifies whether the category name for a group of entries appears in the table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isCategoryHeaderIncluded?: boolean; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - altTextDescription?: boolean; + isEntryFormattingKept?: boolean; /** - * Specifies a string that contains the title for the inline image. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - altTextTitle?: boolean; + isPassimUsed?: boolean; /** - * Specifies a number that describes the height of the inline image. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - height?: boolean; + pageNumberSeparator?: boolean; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - hyperlink?: boolean; + pageRangeSeparator?: boolean; /** - * Gets the format of the inline image. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - imageFormat?: boolean; + sequenceName?: boolean; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - lockAspectRatio?: boolean; + sequenceSeparator?: boolean; /** - * Specifies a number that describes the width of the inline image. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - width?: boolean; + tabLeader?: boolean; } /** - * Contains a collection of {@link Word.InlinePicture} objects. + * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - interface InlinePictureCollectionLoadOptions { + interface TableOfAuthoritiesCollectionLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. - * - * @remarks - * [Api set: WordApi 1.2] - */ - paragraph?: Word.Interfaces.ParagraphLoadOptions; - /** - * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; - /** - * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTable?: Word.Interfaces.TableLoadOptions; + * For EACH ITEM in the collection: Specifies the name of the bookmark from which to collect table of authorities entries. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + bookmark?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + * 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 {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + category?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + * 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. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + entrySeparator?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + * For EACH ITEM in the collection: Specifies whether the category name for a group of entries appears in the table of authorities. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isCategoryHeaderIncluded?: boolean; /** - * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. + * For EACH ITEM in the collection: Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - altTextDescription?: boolean; + isEntryFormattingKept?: boolean; /** - * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. + * 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". * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - altTextTitle?: boolean; + isPassimUsed?: boolean; /** - * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. + * 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. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - height?: boolean; + pageNumberSeparator?: boolean; /** - * For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * 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. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - hyperlink?: boolean; + pageRangeSeparator?: boolean; /** - * For EACH ITEM in the collection: Gets the format of the inline image. + * For EACH ITEM in the collection: Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - imageFormat?: boolean; + sequenceName?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * 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. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - lockAspectRatio?: boolean; + sequenceSeparator?: boolean; /** - * For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. + * For EACH ITEM in the collection: Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - width?: boolean; + tabLeader?: boolean; } /** - * Contains a collection of {@link Word.Paragraph} objects. + * Represents a category used in a table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - interface ListLoadOptions { + interface TableOfAuthoritiesCategoryLoadOptions { /** 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; /** - * Gets the list's ID. + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - id?: boolean; + name?: boolean; + } + /** + * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface TableOfAuthoritiesCategoryCollectionLoadOptions { /** - * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. - * - * @remarks - * [Api set: WordApi 1.3] + 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`). */ - levelExistences?: boolean; + $all?: boolean; /** - * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. + * For EACH ITEM in the collection: Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - levelTypes?: boolean; + name?: boolean; } /** - * Contains a collection of {@link Word.List} objects. + * Represents a table of contents in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - interface ListCollectionLoadOptions { + interface TableOfContentsLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Gets the list's ID. + * Gets the portion of a document that is this table of contents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - id?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - levelExistences?: boolean; + areFieldsUsed?: boolean; /** - * For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - levelTypes?: boolean; - } - /** - * Represents the paragraph list item format. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ListItemLoadOptions { + areHyperlinksUsedOnWeb?: boolean; /** - 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`). + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the level of the item in the list. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - level?: boolean; + arePageNumbersIncluded?: boolean; /** - * Gets the list item bullet, number, or picture as a string. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - listString?: boolean; + arePageNumbersRightAligned?: boolean; /** - * Gets the list item order number in relation to its siblings. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - siblingIndex?: boolean; + lowerHeadingLevel?: boolean; + /** + * Specifies the character between entries and their page numbers in the table of contents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tabLeader?: boolean; + /** + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + tableId?: boolean; + /** + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + upperHeadingLevel?: boolean; } /** - * Represents a list level. + * Represents a collection of {@link Word.TableOfContents} objects in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - interface ListLevelLoadOptions { + interface TableOfContentsCollectionLoadOptions { /** 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; /** - * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * For EACH ITEM in the collection: Gets the portion of a document that is this table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - font?: Word.Interfaces.FontLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. + * For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - alignment?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies the name of the style that's linked to the `ListLevel` object. + * For EACH ITEM in the collection: Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - linkedStyle?: boolean; + areFieldsUsed?: boolean; /** - * Specifies the number format for the list level. + * For EACH ITEM in the collection: Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - numberFormat?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies the position (in points) of the number or bullet for the `ListLevel` object. + * For EACH ITEM in the collection: Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - numberPosition?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the number style for the `ListLevel` object. + * For EACH ITEM in the collection: Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - numberStyle?: boolean; + arePageNumbersIncluded?: boolean; /** - * Specifies the list level that must appear before it restarts numbering at 1. + * For EACH ITEM in the collection: Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - resetOnHigher?: boolean; + arePageNumbersRightAligned?: boolean; /** - * Specifies the starting number for the `ListLevel` object. + * For EACH ITEM in the collection: Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - startAt?: boolean; + lowerHeadingLevel?: boolean; /** - * Specifies the tab position for the `ListLevel` object. + * For EACH ITEM in the collection: Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - tabPosition?: boolean; + tabLeader?: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. + * For EACH ITEM in the collection: Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - textPosition?: boolean; + tableId?: boolean; /** - * Specifies the character inserted after the number for the list level. + * For EACH ITEM in the collection: Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - trailingCharacter?: boolean; + upperHeadingLevel?: boolean; } /** - * Contains a collection of {@link Word.ListLevel} objects. + * Represents a table of figures in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - interface ListLevelCollectionLoadOptions { + interface TableOfFiguresLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * Gets the portion of a document that is this table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - font?: Word.Interfaces.FontLoadOptions; - /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - alignment?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the name of the style that's linked to the `ListLevel` object. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - linkedStyle?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * For EACH ITEM in the collection: Specifies the number format for the list level. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - numberFormat?: boolean; + areFieldsUsed?: boolean; /** - * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the `ListLevel` object. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - numberPosition?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * For EACH ITEM in the collection: Specifies the number style for the `ListLevel` object. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - numberStyle?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * For EACH ITEM in the collection: Specifies the list level that must appear before it restarts numbering at 1. + * Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - resetOnHigher?: boolean; + arePageNumbersIncluded?: boolean; /** - * For EACH ITEM in the collection: Specifies the starting number for the `ListLevel` object. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - startAt?: boolean; + arePageNumbersRightAligned?: boolean; /** - * For EACH ITEM in the collection: Specifies the tab position for the `ListLevel` object. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - tabPosition?: boolean; + captionLabel?: boolean; /** - * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - textPosition?: boolean; + isLabelIncluded?: boolean; /** - * For EACH ITEM in the collection: Specifies the character inserted after the number for the list level. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - trailingCharacter?: boolean; - } - /** - * Represents a list template. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface ListTemplateLoadOptions { + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + lowerHeadingLevel?: boolean; /** - 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`). + * Specifies the character between entries and their page numbers in the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + tabLeader?: boolean; /** - * Specifies whether the list template is outline numbered. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.4] */ - outlineNumbered?: boolean; + tableId?: boolean; + /** + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + upperHeadingLevel?: boolean; } /** - * Represents a footnote or endnote. + * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - interface NoteItemLoadOptions { + interface TableOfFiguresCollectionLoadOptions { /** 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; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ - body?: Word.Interfaces.BodyLoadOptions; - /** - * Represents a footnote or endnote reference in the main document. + * For EACH ITEM in the collection: Gets the portion of a document that is this table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - reference?: Word.Interfaces.RangeLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Represents the note item type: footnote or endnote. + * For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - type?: boolean; - } - /** - * Contains a collection of {@link Word.NoteItem} objects. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface NoteItemCollectionLoadOptions { + areBuiltInHeadingStylesUsed?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; - /** - * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ - body?: Word.Interfaces.BodyLoadOptions; + areFieldsUsed?: boolean; /** - * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ - reference?: Word.Interfaces.RangeLoadOptions; + * For EACH ITEM in the collection: Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areHyperlinksUsedOnWeb?: boolean; /** - * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. + * For EACH ITEM in the collection: Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - type?: boolean; - } - /** - * Represents a page in the document. `Page` objects manage the page layout and content. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface PageLoadOptions { + arePageNumbersHiddenOnWeb?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies whether page numbers are included in the table of figures. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + arePageNumbersIncluded?: boolean; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * For EACH ITEM in the collection: Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - height?: boolean; + arePageNumbersRightAligned?: boolean; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * For EACH ITEM in the collection: Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - index?: boolean; + captionLabel?: boolean; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * For EACH ITEM in the collection: Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - width?: boolean; - } - /** - * Represents the collection of {@link Word.Page} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface PageCollectionLoadOptions { + isLabelIncluded?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + lowerHeadingLevel?: boolean; /** - * For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box. + * For EACH ITEM in the collection: Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - height?: boolean; + tabLeader?: boolean; /** - * For EACH ITEM in the collection: Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * For EACH ITEM in the collection: Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - index?: boolean; + tableId?: boolean; /** - * For EACH ITEM in the collection: Gets the width, in points, of the paper defined in the Page Setup dialog box. + * For EACH ITEM in the collection: Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - width?: boolean; + upperHeadingLevel?: boolean; } /** - * Represents a single paragraph in a selection, range, content control, or document body. + * Represents a row in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - interface ParagraphLoadOptions { + interface TableRowLoadOptions { /** 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; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - list?: Word.Interfaces.ListLoadOptions; - /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItem?: Word.Interfaces.ListItemLoadOptions; - /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; - /** - * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listOrNullObject?: Word.Interfaces.ListLoadOptions; - /** - * Gets the parent body of the paragraph. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; - /** - * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.3] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets parent table. * * @remarks * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; - /** - * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; - /** - * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Returns the `Range` object that represents the table row. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Returns the `ShadingUniversal` object that represents the shading of the table row. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - alignment?: boolean; + cellCount?: boolean; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - firstLineIndent?: boolean; + horizontalAlignment?: boolean; /** - * Indicates the paragraph is the last one inside its parent body. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks * [Api set: WordApi 1.3] */ - isLastParagraph?: boolean; + isHeader?: boolean; /** - * Checks whether the paragraph is a list item. + * Specifies the preferred height of the row in points. * * @remarks * [Api set: WordApi 1.3] */ - isListItem?: boolean; + preferredHeight?: boolean; /** - * Specifies the left indent value, in points, for the paragraph. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - leftIndent?: boolean; + rowIndex?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineSpacing?: boolean; + shadingColor?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineUnitAfter?: boolean; + values?: boolean; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineUnitBefore?: boolean; + verticalAlignment?: boolean; + } + /** + * Contains the collection of the document's {@link Word.TableRow} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface TableRowCollectionLoadOptions { /** - * Specifies the outline level for the paragraph. - * - * @remarks - * [Api set: WordApi 1.1] + 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`). */ - outlineLevel?: boolean; + $all?: boolean; /** - * Specifies the right indent value, in points, for the paragraph. + * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + font?: Word.Interfaces.FontLoadOptions; + /** + * For EACH ITEM in the collection: Gets parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `Range` object that represents the table row. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table row. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; + /** + * For EACH ITEM in the collection: Gets the number of cells in the row. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - rightIndent?: boolean; + cellCount?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - spaceAfter?: boolean; + horizontalAlignment?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * For EACH ITEM in the collection: Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - spaceBefore?: boolean; + isHeader?: boolean; /** - * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: boolean; + preferredHeight?: boolean; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Gets the index of the row in its parent table. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn?: boolean; + rowIndex?: boolean; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks * [Api set: WordApi 1.3] */ - tableNestingLevel?: boolean; + shadingColor?: boolean; /** - * Gets the text of the paragraph. + * For EACH ITEM in the collection: Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - text?: boolean; + values?: boolean; /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * For EACH ITEM in the collection: Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - uniqueLocalId?: boolean; + verticalAlignment?: boolean; } /** - * Contains a collection of {@link Word.Paragraph} objects. + * Represents a table cell in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - interface ParagraphCollectionLoadOptions { + interface TableCellLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - list?: Word.Interfaces.ListLoadOptions; - /** - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItem?: Word.Interfaces.ListItemLoadOptions; - /** - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; - /** - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listOrNullObject?: Word.Interfaces.ListLoadOptions; - /** - * For EACH ITEM in the collection: Gets the parent body of the paragraph. + * Gets the `Body` object of the cell. * * @remarks * [Api set: WordApi 1.3] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * Returns the `TableColumn` object that represents the table column that contains this cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + column?: Word.Interfaces.TableColumnLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the parent row of the cell. * * @remarks * [Api set: WordApi 1.3] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + parentRow?: Word.Interfaces.TableRowLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the parent table of the cell. * * @remarks * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; - /** - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Returns the `ShadingUniversal` object that represents the shading of the table cell. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + * Gets the index of the cell in its row. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cellIndex?: boolean; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + */ + columnWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - alignment?: boolean; + horizontalAlignment?: boolean; /** - * For EACH ITEM in the collection: Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - firstLineIndent?: boolean; + rowIndex?: boolean; /** - * For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks * [Api set: WordApi 1.3] */ - isLastParagraph?: boolean; + shadingColor?: boolean; /** - * For EACH ITEM in the collection: Checks whether the paragraph is a list item. + * Specifies the text of the cell. * * @remarks * [Api set: WordApi 1.3] */ - isListItem?: boolean; + value?: boolean; /** - * For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - leftIndent?: boolean; + verticalAlignment?: boolean; /** - * For EACH ITEM in the collection: Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineSpacing?: boolean; + width?: boolean; + } + /** + * Contains the collection of the document's {@link Word.TableCell} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface TableCellCollectionLoadOptions { /** - * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph. + 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; + /** + * For EACH ITEM in the collection: Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + body?: Word.Interfaces.BodyLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `TableColumn` object that represents the table column that contains this cell. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + column?: Word.Interfaces.TableColumnLoadOptions; + /** + * For EACH ITEM in the collection: Gets the parent row of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentRow?: Word.Interfaces.TableRowLoadOptions; + /** + * For EACH ITEM in the collection: Gets the parent table of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table cell. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; + /** + * For EACH ITEM in the collection: Gets the index of the cell in its row. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineUnitAfter?: boolean; + cellIndex?: boolean; /** - * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph. + * For EACH ITEM in the collection: Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lineUnitBefore?: boolean; + columnWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the outline level for the paragraph. + * For EACH ITEM in the collection: Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - outlineLevel?: boolean; + horizontalAlignment?: boolean; /** - * For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph. + * For EACH ITEM in the collection: Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - rightIndent?: boolean; + rowIndex?: boolean; /** - * For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph. + * For EACH ITEM in the collection: Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - spaceAfter?: boolean; + shadingColor?: boolean; /** - * For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph. + * For EACH ITEM in the collection: Specifies the text of the cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - spaceBefore?: boolean; + value?: boolean; /** - * For EACH ITEM in the collection: Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: boolean; + verticalAlignment?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Gets the width of the cell in points. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn?: boolean; + width?: boolean; + } + /** + * Specifies the border style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface TableBorderLoadOptions { /** - * For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + 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; + /** + * Specifies the table border color. * * @remarks * [Api set: WordApi 1.3] */ - tableNestingLevel?: boolean; + color?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the paragraph. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - text?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - uniqueLocalId?: boolean; + width?: boolean; } /** - * Represents a style of paragraph in a document. + * Represents a document template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - interface ParagraphFormatLoadOptions { + interface TemplateLoadOptions { /** 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; /** - * Specifies the alignment for the specified paragraphs. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - alignment?: boolean; + farEastLineBreakLanguage?: boolean; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies the line break control level for the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - firstLineIndent?: boolean; + farEastLineBreakLevel?: boolean; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Returns the name of the template, including the drive or Web path. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - keepTogether?: boolean; + fullName?: boolean; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - keepWithNext?: boolean; + hasNoProofing?: boolean; /** - * Specifies the left indent. + * Specifies the character spacing adjustment for the template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - leftIndent?: boolean; + justificationMode?: boolean; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - lineSpacing?: boolean; + kerningByAlgorithm?: boolean; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - lineUnitAfter?: boolean; + languageId?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - lineUnitBefore?: boolean; + languageIdFarEast?: boolean; /** - * Specifies whether left and right indents are the same width. + * Returns only the name of the document template (excluding any path or other location information). * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - mirrorIndents?: boolean; + name?: boolean; /** - * Specifies the outline level for the specified paragraphs. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - outlineLevel?: boolean; + noLineBreakAfter?: boolean; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - rightIndent?: boolean; + noLineBreakBefore?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Returns the path to the document template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - spaceAfter?: boolean; + path?: boolean; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - spaceBefore?: boolean; + saved?: boolean; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Returns the template type. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.3] */ - widowControl?: boolean; + type?: boolean; } /** - * Represents a contiguous area in a document. + * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. + This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. + To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - interface RangeLoadOptions { + interface TemplateCollectionLoadOptions { /** 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; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - listFormat?: Word.Interfaces.ListFormatLoadOptions; - /** - * Gets the parent body of the range. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; - /** - * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; - /** - * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTable?: Word.Interfaces.TableLoadOptions; - /** - * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; - /** - * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; - /** - * Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + * For EACH ITEM in the collection: Specifies the East Asian language to use when breaking lines of text in the document or template. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + farEastLineBreakLanguage?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + * For EACH ITEM in the collection: Specifies the line break control level for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + farEastLineBreakLevel?: boolean; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * For EACH ITEM in the collection: Returns the name of the template, including the drive or Web path. * * @remarks * [Api set: WordApiDesktop 1.3] */ - hasNoProofing?: boolean; + fullName?: boolean; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * For EACH ITEM in the collection: Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - hyperlink?: boolean; + hasNoProofing?: boolean; /** - * Checks whether the range length is zero. + * For EACH ITEM in the collection: Specifies the character spacing adjustment for the template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - isEmpty?: boolean; + justificationMode?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * For EACH ITEM in the collection: Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - languageDetected?: boolean; + kerningByAlgorithm?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the range. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language in the template. * * @remarks * [Api set: WordApiDesktop 1.3] */ languageId?: boolean; /** - * Specifies an East Asian language for the range. + * For EACH ITEM in the collection: Specifies an East Asian language for the language in the template. * * @remarks * [Api set: WordApiDesktop 1.3] */ languageIdFarEast?: boolean; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * For EACH ITEM in the collection: Returns only the name of the document template (excluding any path or other location information). * * @remarks * [Api set: WordApiDesktop 1.3] */ - languageIdOther?: boolean; + name?: boolean; /** - * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - style?: boolean; + noLineBreakAfter?: boolean; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - styleBuiltIn?: boolean; + noLineBreakBefore?: boolean; /** - * Gets the text of the range. + * For EACH ITEM in the collection: Returns the path to the document template. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.3] */ - text?: boolean; + path?: boolean; + /** + * For EACH ITEM in the collection: Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + saved?: boolean; + /** + * For EACH ITEM in the collection: Returns the template type. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + type?: boolean; } /** - * Contains a collection of {@link Word.Range} objects. + * Represents a tracked change in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - interface RangeCollectionLoadOptions { + interface TrackedChangeLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - listFormat?: Word.Interfaces.ListFormatLoadOptions; - /** - * For EACH ITEM in the collection: Gets the parent body of the range. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; - /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; - /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; - /** - * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTable?: Word.Interfaces.TableLoadOptions; - /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; - /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; - /** - * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; - /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; - /** - * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - hasNoProofing?: boolean; - /** - * For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - hyperlink?: boolean; + author?: boolean; /** - * For EACH ITEM in the collection: Checks whether the range length is zero. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - isEmpty?: boolean; + date?: boolean; /** - * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - languageDetected?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the range. + * Gets the type of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - languageId?: boolean; + type?: boolean; + } + /** + * Contains a collection of {@link Word.TrackedChange} objects. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface TrackedChangeCollectionLoadOptions { /** - * For EACH ITEM in the collection: Specifies an East Asian language for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - languageIdFarEast?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Specifies a language for the range that isn't classified as an East Asian language. + * For EACH ITEM in the collection: Gets the author of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.6] */ - languageIdOther?: boolean; + author?: boolean; /** - * For EACH ITEM in the collection: Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Gets the date of the tracked change. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - style?: boolean; + date?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Gets the text of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - styleBuiltIn?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the range. + * For EACH ITEM in the collection: Gets the type of the tracked change. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - text?: boolean; + type?: boolean; } /** - * Specifies the options to be included in a search operation. - To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. + * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - interface SearchOptionsLoadOptions { + interface ViewLoadOptions { /** 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; /** - * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. + * Gets the instance of a `RevisionsFilter` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + revisionsFilter?: Word.Interfaces.RevisionsFilterLoadOptions; + /** + * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - ignorePunct?: boolean; + areAllNonprintingCharactersDisplayed?: boolean; /** - * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - ignoreSpace?: boolean; + areBackgroundsDisplayed?: boolean; /** - * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - matchCase?: boolean; + areBookmarksIndicated?: boolean; /** - * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - matchPrefix?: boolean; + areCommentsDisplayed?: boolean; /** - * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - matchSuffix?: boolean; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - matchWholeWord?: boolean; + areCropMarksDisplayed?: boolean; /** - * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. + * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.4] */ - matchWildcards?: boolean; - } - /** - * Represents a section in a Word document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface SectionLoadOptions { + areDrawingsDisplayed?: boolean; /** - 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`). + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + areEditableRangesShaded?: boolean; /** - * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ - body?: Word.Interfaces.BodyLoadOptions; + * Specifies whether field codes are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areFieldCodesDisplayed?: boolean; /** - * Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areFormatChangesDisplayed?: boolean; /** - * Specifies if the section is protected for forms. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - protectedForForms?: boolean; - } - /** - * Contains the collection of the document's {@link Word.Section} objects. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface SectionCollectionLoadOptions { + areInkAnnotationsDisplayed?: boolean; /** - 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`). + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ - body?: Word.Interfaces.BodyLoadOptions; + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areLinesWrappedToWindow?: boolean; /** - * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areObjectAnchorsDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies if the section is protected for forms. + * Gets whether Microsoft Word displays optional line breaks. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - protectedForForms?: boolean; - } - /** - * Represents a setting of the add-in. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface SettingLoadOptions { + areOptionalBreaksDisplayed?: boolean; /** - 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`). + * Gets whether optional hyphens are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + areOptionalHyphensDisplayed?: boolean; /** - * Gets the key of the setting. + * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - key?: boolean; + areOtherAuthorsVisible?: boolean; /** - * Specifies the value of the setting. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - value?: boolean; - } - /** - * Contains the collection of {@link Word.Setting} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface SettingCollectionLoadOptions { + arePageBoundariesDisplayed?: boolean; /** - 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`). + * Gets whether paragraph marks are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + areParagraphsMarksDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets the key of the setting. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - key?: boolean; + arePicturePlaceholdersDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the setting. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.4] */ - value?: boolean; - } - /** - * Contains a collection of {@link Word.Style} objects. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface StyleCollectionLoadOptions { + areRevisionsAndCommentsDisplayed?: boolean; /** - 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`). + * Gets whether space characters are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + areSpacesIndicated?: boolean; /** - * For EACH ITEM in the collection: Specifies a `BorderCollection` object that represents all the borders for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - borders?: Word.Interfaces.BorderCollectionLoadOptions; + * Specifies whether table gridlines are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areTableGridlinesDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets a `Font` object that represents the character formatting of the style. - * - * @remarks - * [Api set: WordApi 1.5] - */ - font?: Word.Interfaces.FontLoadOptions; + * Gets whether tab characters are displayed. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areTabsDisplayed?: boolean; /** - * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - frame?: Word.Interfaces.FrameLoadOptions; + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + areTextBoundariesDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - linkStyle?: Word.Interfaces.StyleLoadOptions; + * Specifies the column width in Reading mode. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + columnWidth?: boolean; /** - * For EACH ITEM in the collection: Gets a `ListTemplate` object that represents the list formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + * Gets on-screen shading for fields. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fieldShading?: boolean; /** - * For EACH ITEM in the collection: Gets a `ParagraphFormat` object that represents the paragraph settings for the style. - * - * @remarks - * [Api set: WordApi 1.5] - */ - paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isDraft?: boolean; /** - * For EACH ITEM in the collection: Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. - * - * @remarks - * [Api set: WordApi 1.6] - */ - shading?: Word.Interfaces.ShadingLoadOptions; + * Specifies whether only the first line of body text is shown in outline view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFirstLineOnlyDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets a `TableStyle` object representing style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ - tableStyle?: Word.Interfaces.TableStyleLoadOptions; + * Specifies whether character formatting is visible in outline view. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isFormatDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the style is automatically redefined based on the selection. + * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - automaticallyUpdate?: boolean; + isFullScreen?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style. + * Gets whether text formatted as hidden text is displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] + */ + isHiddenTextDisplayed?: boolean; + /** + * Gets whether highlight formatting is displayed and printed with the document. * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - baseStyle?: boolean; + isHighlightingDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets whether the style is a built-in style. + * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - builtIn?: boolean; + isInConflictMode?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - hasProofing?: boolean; + isInPanning?: boolean; /** - * For EACH ITEM in the collection: Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * Specifies whether the document is being viewed in reading layout view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - inUse?: boolean; + isInReadingLayout?: boolean; /** - * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the style. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageId?: boolean; + isMailMergeDataView?: boolean; /** - * For EACH ITEM in the collection: Specifies an East Asian language for the style. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - languageIdFarEast?: boolean; + isMainTextLayerVisible?: boolean; /** - * For EACH ITEM in the collection: Gets whether the style is a linked style that can be used for both paragraph and character formatting. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - linked?: boolean; + isPointerShownAsMagnifier?: boolean; /** - * For EACH ITEM in the collection: Returns the list level for the style. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - listLevelNumber?: boolean; + isReadingLayoutActualView?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the style cannot be changed or edited. + * Specifies whether XML tags are visible in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - locked?: boolean; + isXmlMarkupVisible?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the style in the language of the user. + * Specifies the display mode for tracked changes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - nameLocal?: boolean; + markupMode?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. + * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] + */ + pageColor?: boolean; + /** + * Specifies the page movement type. * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.4] */ - nextParagraphStyle?: boolean; + pageMovementType?: boolean; /** - * For EACH ITEM in the collection: Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + readingLayoutTruncateMargins?: boolean; /** - * For EACH ITEM in the collection: Specifies the priority. + * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - priority?: boolean; + revisionsBalloonSide?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style. + * Specifies the width of the revision balloons. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - quickStyle?: boolean; + revisionsBalloonWidth?: boolean; /** - * For EACH ITEM in the collection: Gets the style type. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - type?: boolean; + revisionsBalloonWidthType?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. + * Specifies the document element displayed in print layout view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - unhideWhenUsed?: boolean; + seekView?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies the active window pane. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.4] */ - visibility?: boolean; + splitSpecial?: boolean; + /** + * Specifies the view type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: boolean; } /** - * Represents a style in a Word document. + * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - interface StyleLoadOptions { + interface ShapeLoadOptions { /** 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; /** - * Specifies a `BorderCollection` object that represents all the borders for the style. + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - borders?: Word.Interfaces.BorderCollectionLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets a `Font` object that represents the character formatting of the style. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontLoadOptions; + canvas?: Word.Interfaces.CanvasLoadOptions; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - frame?: Word.Interfaces.FrameLoadOptions; + fill?: Word.Interfaces.ShapeFillLoadOptions; /** - * Specifies a link between a paragraph and a character style. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - linkStyle?: Word.Interfaces.StyleLoadOptions; + parentCanvas?: Word.Interfaces.ShapeLoadOptions; /** - * Gets a `ListTemplate` object that represents the list formatting for the style. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + parentGroup?: Word.Interfaces.ShapeLoadOptions; /** - * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; + shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; /** - * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * Gets the `TextFrame` object of the shape. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - shading?: Word.Interfaces.ShadingLoadOptions; + textFrame?: Word.Interfaces.TextFrameLoadOptions; /** - * Gets a `TableStyle` object representing style properties that can be applied to a table. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - tableStyle?: Word.Interfaces.TableStyleLoadOptions; + textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - automaticallyUpdate?: boolean; + allowOverlap?: boolean; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApiDesktop 1.2] */ - baseStyle?: boolean; + altTextDescription?: boolean; /** - * Gets whether the style is a built-in style. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - builtIn?: boolean; + geometricShapeType?: boolean; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - hasProofing?: boolean; + height?: boolean; /** - * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - inUse?: boolean; + heightRelative?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Gets an integer that represents the shape identifier. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - languageId?: boolean; + id?: boolean; /** - * Specifies an East Asian language for the style. + * Check whether this shape is a child of a group shape or a canvas shape. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - languageIdFarEast?: boolean; + isChild?: boolean; /** - * Gets whether the style is a linked style that can be used for both paragraph and character formatting. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - linked?: boolean; + left?: boolean; /** - * Returns the list level for the style. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - listLevelNumber?: boolean; + leftRelative?: boolean; /** - * Specifies whether the style cannot be changed or edited. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - locked?: boolean; + lockAspectRatio?: boolean; /** - * Gets the name of the style in the language of the user. + * The name of the shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - nameLocal?: boolean; + name?: boolean; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApiDesktop 1.2] */ - nextParagraphStyle?: boolean; + relativeHorizontalPosition?: boolean; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + relativeHorizontalSize?: boolean; /** - * Specifies the priority. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - priority?: boolean; + relativeVerticalPosition?: boolean; /** - * Specifies whether the style corresponds to an available quick style. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - quickStyle?: boolean; + relativeVerticalSize?: boolean; /** - * Gets the style type. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - type?: boolean; + rotation?: boolean; /** - * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - unhideWhenUsed?: boolean; + top?: boolean; /** - * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - visibility?: boolean; - } - /** - * Represents the `Shading` object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ShadingLoadOptions { + topRelative?: boolean; /** - 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`). + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - $all?: boolean; + type?: boolean; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - backgroundPatternColor?: boolean; + visible?: boolean; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - foregroundPatternColor?: boolean; + width?: boolean; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - texture?: boolean; + widthRelative?: boolean; } /** - * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. + * Represents a shape group in the document. To get the corresponding {@link Word.Shape} object, use `ShapeGroup.shape`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - interface ShadingUniversalLoadOptions { + interface ShapeGroupLoadOptions { /** 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; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - backgroundPatternColor?: boolean; + * Gets the `Shape` object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shape?: Word.Interfaces.ShapeLoadOptions; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Gets an integer that represents the shape group identifier. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - backgroundPatternColorIndex?: boolean; + id?: boolean; + } + /** + * Represents a canvas in the document. To get the corresponding {@link Word.Shape} object, use `Canvas.shape`. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface CanvasLoadOptions { /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - foregroundPatternColor?: boolean; + $all?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - foregroundPatternColorIndex?: boolean; + * Gets the `Shape` object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shape?: Word.Interfaces.ShapeLoadOptions; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Gets an integer that represents the canvas identifier. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.2] */ - texture?: boolean; + id?: boolean; } /** - * Represents a table in a Word document. + * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - interface TableLoadOptions { + interface ShapeCollectionLoadOptions { /** 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; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * For EACH ITEM in the collection: Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the parent body of the table. + * For EACH ITEM in the collection: Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + canvas?: Word.Interfaces.CanvasLoadOptions; /** - * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * For EACH ITEM in the collection: Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + fill?: Word.Interfaces.ShapeFillLoadOptions; /** - * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + parentCanvas?: Word.Interfaces.ShapeLoadOptions; /** - * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTable?: Word.Interfaces.TableLoadOptions; + parentGroup?: Word.Interfaces.ShapeLoadOptions; /** - * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; /** - * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Gets the `TextFrame` object of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + textFrame?: Word.Interfaces.TextFrameLoadOptions; /** - * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; /** - * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. + * For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + */ + allowOverlap?: boolean; + /** + * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - alignment?: boolean; + altTextDescription?: boolean; /** - * Specifies the number of header rows. + * For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - headerRowCount?: boolean; + geometricShapeType?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. + * For EACH ITEM in the collection: The height, in points, of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: boolean; + height?: boolean; /** - * Indicates whether all of the table rows are uniform. + * For EACH ITEM in the collection: The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - isUniform?: boolean; + heightRelative?: boolean; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * For EACH ITEM in the collection: Gets an integer that represents the shape identifier. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - nestingLevel?: boolean; + id?: boolean; /** - * Gets the number of rows in the table. + * For EACH ITEM in the collection: Check whether this shape is a child of a group shape or a canvas shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowCount?: boolean; + isChild?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - shadingColor?: boolean; + left?: boolean; /** - * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - style?: boolean; + leftRelative?: boolean; /** - * Specifies whether the table has banded columns. + * For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBandedColumns?: boolean; + lockAspectRatio?: boolean; /** - * Specifies whether the table has banded rows. + * For EACH ITEM in the collection: The name of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBandedRows?: boolean; + name?: boolean; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBuiltIn?: boolean; + relativeHorizontalPosition?: boolean; /** - * Specifies whether the table has a first column with a special style. + * For EACH ITEM in the collection: The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleFirstColumn?: boolean; + relativeHorizontalSize?: boolean; /** - * Specifies whether the table has a last column with a special style. + * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleLastColumn?: boolean; + relativeVerticalPosition?: boolean; /** - * Specifies whether the table has a total (last) row with a special style. + * For EACH ITEM in the collection: The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleTotalRow?: boolean; + relativeVerticalSize?: boolean; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - values?: boolean; + rotation?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. + * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - verticalAlignment?: boolean; + top?: boolean; /** - * Specifies the width of the table in points. + * For EACH ITEM in the collection: The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - width?: boolean; - } - /** - * Represents the `TableStyle` object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface TableStyleLoadOptions { + topRelative?: boolean; /** - 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`). + * For EACH ITEM in the collection: Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - $all?: boolean; + type?: boolean; /** - * Specifies the table's alignment against the page margin. + * For EACH ITEM in the collection: Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - alignment?: boolean; + visible?: boolean; /** - * Specifies whether lines in tables formatted with a style break across pages. + * For EACH ITEM in the collection: The width, in points, of the shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - allowBreakAcrossPage?: boolean; + width?: boolean; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * For EACH ITEM in the collection: The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - bottomCellMargin?: boolean; + widthRelative?: boolean; + } + /** + * Represents the fill formatting of a {@link Word.Shape} object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface ShapeFillLoadOptions { /** - * Specifies the spacing (in points) between the cells in a table style. + 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; + /** + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - cellSpacing?: boolean; + backgroundColor?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - leftCellMargin?: boolean; + foregroundColor?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - rightCellMargin?: boolean; + transparency?: boolean; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - topCellMargin?: boolean; + type?: boolean; } /** - * Contains the collection of the document's {@link Word.Table} objects. + * Represents the text frame of a {@link Word.Shape} object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - interface TableCollectionLoadOptions { + interface TextFrameLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * For EACH ITEM in the collection: Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; - /** - * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; - /** - * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; - /** - * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTable?: Word.Interfaces.TableLoadOptions; - /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + * Specifies the automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + autoSizeSetting?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + * Specifies the bottom margin, in points, of the text frame. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + bottomMargin?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + * Returns `true` if the text frame contains text, otherwise, `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + hasText?: boolean; /** - * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. + * Specifies the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - alignment?: boolean; + leftMargin?: boolean; /** - * For EACH ITEM in the collection: Specifies the number of header rows. + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - headerRowCount?: boolean; + noTextRotation?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: boolean; + orientation?: boolean; /** - * For EACH ITEM in the collection: Indicates whether all of the table rows are uniform. + * Specifies the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - isUniform?: boolean; + rightMargin?: boolean; /** - * For EACH ITEM in the collection: Gets the nesting level of the table. Top-level tables have level 1. + * Specifies the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - nestingLevel?: boolean; + topMargin?: boolean; /** - * For EACH ITEM in the collection: Gets the number of rows in the table. + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowCount?: boolean; + verticalAlignment?: boolean; /** - * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - shadingColor?: boolean; + wordWrap?: boolean; + } + /** + * Represents all the properties for wrapping text around a {@link Word.Shape}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface ShapeTextWrapLoadOptions { /** - * For EACH ITEM in the collection: Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + 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; + /** + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - style?: boolean; + bottomDistance?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has banded columns. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBandedColumns?: boolean; + leftDistance?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has banded rows. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBandedRows?: boolean; + rightDistance?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBuiltIn?: boolean; + side?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a first column with a special style. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleFirstColumn?: boolean; + topDistance?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a last column with a special style. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleLastColumn?: boolean; + type?: boolean; + } + /** + * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface ReviewerLoadOptions { /** - * For EACH ITEM in the collection: Specifies whether the table has a total (last) row with a special style. + 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; + /** + * Specifies if the `Reviewer` object is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - styleTotalRow?: boolean; + isVisible?: boolean; + } + /** + * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface ReviewerCollectionLoadOptions { /** - * For EACH ITEM in the collection: Specifies the text values in the table, as a 2D JavaScript array. + 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; + /** + * For EACH ITEM in the collection: Specifies if the `Reviewer` object is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - values?: boolean; + isVisible?: boolean; + } + /** + * Represents the current settings related to the display of reviewers' comments and revision marks in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface RevisionsFilterLoadOptions { /** - * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. + 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; + /** + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: boolean; + markup?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the table in points. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: boolean; + view?: boolean; } /** - * Represents a table column in a Word document. + * Represents a single item in a {@link Word.RepeatingSectionContentControl}. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface TableColumnLoadOptions { + interface RepeatingSectionItemLoadOptions { /** 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; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApiDesktop 1.3] */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Represents a single tracked change in a document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface RevisionLoadOptions { /** - * Returns the position of this column in a collection. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - columnIndex?: boolean; + $all?: boolean; /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - isFirst?: boolean; + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + movedRange?: Word.Interfaces.RangeLoadOptions; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets the name of the user who made the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isLast?: boolean; + author?: boolean; /** - * Returns the nesting level of the column. + * Gets the date and time when the tracked change was made. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nestingLevel?: boolean; + date?: boolean; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Gets the description of tracked formatting changes in the revision. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredWidth?: boolean; + formatDescription?: boolean; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Gets a number that represents the position of this item in a collection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredWidthType?: boolean; + index?: boolean; /** - * Specifies the width of the column, in points. + * Gets the revision type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: boolean; + type?: boolean; } /** - * Represents a collection of {@link Word.TableColumn} objects in a Word document. + * A collection of {@link Word.Revision} objects that represent the changes marked with revision marks in a range or document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - interface TableColumnCollectionLoadOptions { + interface RevisionCollectionLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * For EACH ITEM in the collection: Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; - /** - * For EACH ITEM in the collection: Returns the position of this column in a collection. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - columnIndex?: boolean; + movedRange?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Returns `true` if the column or row is the first one in the table; `false` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - isFirst?: boolean; + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Returns `true` if the column or row is the last one in the table; `false` otherwise. + * For EACH ITEM in the collection: Gets the name of the user who made the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isLast?: boolean; + author?: boolean; /** - * For EACH ITEM in the collection: Returns the nesting level of the column. + * For EACH ITEM in the collection: Gets the date and time when the tracked change was made. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - nestingLevel?: boolean; + date?: boolean; /** - * For EACH ITEM in the collection: Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * For EACH ITEM in the collection: Gets the description of tracked formatting changes in the revision. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredWidth?: boolean; + formatDescription?: boolean; /** - * For EACH ITEM in the collection: Specifies the preferred unit of measurement to use for the width of the table column. + * For EACH ITEM in the collection: Gets a number that represents the position of this item in a collection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - preferredWidthType?: boolean; + index?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the column, in points. + * For EACH ITEM in the collection: Gets the revision type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: boolean; + type?: boolean; } /** - * Represents a row in a Word document. + * Represents the `DatePickerContentControl` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - interface TableRowLoadOptions { + interface DatePickerContentControlLoadOptions { /** 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; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - font?: Word.Interfaces.FontLoadOptions; + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets parent table. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - parentTable?: Word.Interfaces.TableLoadOptions; - /** - * Gets the number of cells in the row. - * - * @remarks - * [Api set: WordApi 1.3] - */ - cellCount?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. - * - * @remarks - * [Api set: WordApi 1.3] - */ - horizontalAlignment?: boolean; + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - isHeader?: boolean; + appearance?: boolean; /** - * Specifies the preferred height of the row in points. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - preferredHeight?: boolean; + color?: boolean; /** - * Gets the index of the row in its parent table. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - rowIndex?: boolean; + dateCalendarType?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the format in which dates are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - shadingColor?: boolean; + dateDisplayFormat?: boolean; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - values?: boolean; + dateDisplayLocale?: boolean; /** - * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks - * [Api set: WordApi 1.3] - */ - verticalAlignment?: boolean; - } - /** - * Contains the collection of the document's {@link Word.TableRow} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface TableRowCollectionLoadOptions { - /** - 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`). + * [Api set: WordApiDesktop 1.3] */ - $all?: boolean; - /** - * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * For EACH ITEM in the collection: Gets parent table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTable?: Word.Interfaces.TableLoadOptions; + dateStorageFormat?: boolean; /** - * For EACH ITEM in the collection: Gets the number of cells in the row. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - cellCount?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - horizontalAlignment?: boolean; + isTemporary?: boolean; /** - * For EACH ITEM in the collection: Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - isHeader?: boolean; + level?: boolean; /** - * For EACH ITEM in the collection: Specifies the preferred height of the row in points. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - preferredHeight?: boolean; + lockContentControl?: boolean; /** - * For EACH ITEM in the collection: Gets the index of the row in its parent table. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - rowIndex?: boolean; + lockContents?: boolean; /** - * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Gets whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - shadingColor?: boolean; + showingPlaceholderText?: boolean; /** - * For EACH ITEM in the collection: Specifies the text values in the row, as a 2D JavaScript array. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - values?: boolean; + tag?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - verticalAlignment?: boolean; + title?: boolean; } /** - * Represents a table cell in a Word document. + * Represents the `PictureContentControl` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - interface TableCellLoadOptions { + interface PictureContentControlLoadOptions { /** 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; /** - * Gets the `Body` object of the cell. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets the parent row of the cell. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - parentRow?: Word.Interfaces.TableRowLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the parent table of the cell. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - parentTable?: Word.Interfaces.TableLoadOptions; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Gets the index of the cell in its row. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - cellIndex?: boolean; + appearance?: boolean; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - columnWidth?: boolean; + color?: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - horizontalAlignment?: boolean; + id?: boolean; /** - * Gets the index of the cell's row in the table. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - rowIndex?: boolean; + isTemporary?: boolean; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - shadingColor?: boolean; + level?: boolean; /** - * Specifies the text of the cell. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - value?: boolean; + lockContentControl?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - verticalAlignment?: boolean; + lockContents?: boolean; /** - * Gets the width of the cell in points. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - width?: boolean; + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + title?: boolean; } /** - * Contains the collection of the document's {@link Word.TableCell} objects. + * Represents the `GroupContentControl` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - interface TableCellCollectionLoadOptions { + interface GroupContentControlLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Gets the `Body` object of the cell. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent row of the cell. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - parentRow?: Word.Interfaces.TableRowLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent table of the cell. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - parentTable?: Word.Interfaces.TableLoadOptions; - /** - * For EACH ITEM in the collection: Gets the index of the cell in its row. - * - * @remarks - * [Api set: WordApi 1.3] - */ - cellIndex?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * For EACH ITEM in the collection: Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - columnWidth?: boolean; + appearance?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - horizontalAlignment?: boolean; + color?: boolean; /** - * For EACH ITEM in the collection: Gets the index of the cell's row in the table. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - rowIndex?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - shadingColor?: boolean; + isTemporary?: boolean; /** - * For EACH ITEM in the collection: Specifies the text of the cell. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - value?: boolean; + level?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - verticalAlignment?: boolean; + lockContentControl?: boolean; /** - * For EACH ITEM in the collection: Gets the width of the cell in points. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] - */ - width?: boolean; - } - /** - * Specifies the border style. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface TableBorderLoadOptions { - /** - 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`). + * [Api set: WordApiDesktop 1.3] */ - $all?: boolean; + lockContents?: boolean; /** - * Specifies the table border color. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - color?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies the type of the table border. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - type?: boolean; + tag?: boolean; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.3] */ - width?: boolean; + title?: boolean; } /** - * Represents a document template. + * Represents the `BuildingBlockGalleryContentControl` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface TemplateLoadOptions { + interface BuildingBlockGalleryContentControlLoadOptions { /** 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; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - farEastLineBreakLanguage?: boolean; + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Specifies the line break control level for the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - farEastLineBreakLevel?: boolean; + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the name of the template, including the drive or Web path. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - fullName?: boolean; + appearance?: boolean; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies the category for the building block content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - hasNoProofing?: boolean; + buildingBlockCategory?: boolean; /** - * Specifies the character spacing adjustment for the template. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - justificationMode?: boolean; + buildingBlockType?: boolean; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - kerningByAlgorithm?: boolean; + color?: boolean; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Gets the identification for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - languageId?: boolean; + id?: boolean; /** - * Specifies an East Asian language for the language in the template. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - languageIdFarEast?: boolean; + isTemporary?: boolean; /** - * Returns only the name of the document template (excluding any path or other location information). + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApiDesktop 1.3] */ - name?: boolean; + level?: boolean; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApiDesktop 1.3] */ - noLineBreakAfter?: boolean; + lockContentControl?: boolean; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApiDesktop 1.3] */ - noLineBreakBefore?: boolean; + lockContents?: boolean; /** - * Returns the path to the document template. + * Gets if the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApiDesktop 1.3] */ - path?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - saved?: boolean; + tag?: boolean; /** - * Returns the template type. + * Specifies the title for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - type?: boolean; + title?: boolean; } /** - * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. - This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. - To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. + * Represents the `RepeatingSectionContentControl` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface TemplateCollectionLoadOptions { + interface RepeatingSectionContentControlLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Specifies the East Asian language to use when breaking lines of text in the document or template. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - farEastLineBreakLanguage?: boolean; + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * For EACH ITEM in the collection: Specifies the line break control level for the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - farEastLineBreakLevel?: boolean; + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Returns the name of the template, including the drive or Web path. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks * [Api set: WordApiDesktop 1.3] */ - fullName?: boolean; + allowInsertDeleteSection?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - hasNoProofing?: boolean; + appearance?: boolean; /** - * For EACH ITEM in the collection: Specifies the character spacing adjustment for the template. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - justificationMode?: boolean; + color?: boolean; /** - * For EACH ITEM in the collection: Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Returns the identification for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - kerningByAlgorithm?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language in the template. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - languageId?: boolean; + isTemporary?: boolean; /** - * For EACH ITEM in the collection: Specifies an East Asian language for the language in the template. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApiDesktop 1.3] */ - languageIdFarEast?: boolean; + level?: boolean; /** - * For EACH ITEM in the collection: Returns only the name of the document template (excluding any path or other location information). + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApiDesktop 1.3] */ - name?: boolean; + lockContentControl?: boolean; /** - * For EACH ITEM in the collection: Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApiDesktop 1.3] */ - noLineBreakAfter?: boolean; + lockContents?: boolean; /** - * For EACH ITEM in the collection: Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - noLineBreakBefore?: boolean; + repeatingSectionItemTitle?: boolean; /** - * For EACH ITEM in the collection: Returns the path to the document template. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApiDesktop 1.3] */ - path?: boolean; + showingPlaceholderText?: boolean; /** - * For EACH ITEM in the collection: Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - saved?: boolean; + tag?: boolean; /** - * For EACH ITEM in the collection: Returns the template type. + * Specifies the title for the content control. * * @remarks * [Api set: WordApiDesktop 1.3] */ - type?: boolean; + title?: boolean; } /** - * Represents a tracked change in a Word document. + * Represents one of the readability statistics for the document or range. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - interface TrackedChangeLoadOptions { + interface ReadabilityStatisticLoadOptions { /** 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; /** - * Gets the author of the tracked change. + * Returns the name of the readability statistic. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - author?: boolean; + name?: boolean; /** - * Gets the date of the tracked change. + * Returns the value of the grammar statistic. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - date?: boolean; + value?: boolean; + } + /** + * Represents a collection of {@link Word.ReadabilityStatistic} objects for the document or range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface ReadabilityStatisticCollectionLoadOptions { /** - * Gets the text of the tracked change. + 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; + /** + * For EACH ITEM in the collection: Returns the name of the readability statistic. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - text?: boolean; + name?: boolean; /** - * Gets the type of the tracked change. + * For EACH ITEM in the collection: Returns the value of the grammar statistic. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - type?: boolean; + value?: boolean; } /** - * Contains a collection of {@link Word.TrackedChange} objects. + * Represents the settings for saving a Word document as a webpage. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - interface TrackedChangeCollectionLoadOptions { + interface WebSettingsLoadOptions { /** 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; + $all?: boolean; + /** + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + allowPng?: boolean; + /** + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + encoding?: boolean; + /** + * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + folderSuffix?: boolean; + /** + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + organizeInFolder?: boolean; + /** + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + pixelsPerInch?: boolean; + /** + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + relyOnCSS?: boolean; /** - * For EACH ITEM in the collection: Gets the author of the tracked change. + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - author?: boolean; + relyOnVectorMarkupLanguage?: boolean; /** - * For EACH ITEM in the collection: Gets the date of the tracked change. + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - date?: boolean; + screenSize?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the tracked change. + * Specifies the target browser for documents viewed in a web browser. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - text?: boolean; + targetBrowser?: boolean; /** - * For EACH ITEM in the collection: Gets the type of the tracked change. + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.4] */ - type?: boolean; + useLongFileNames?: boolean; } /** - * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Represents the collection of {@link Word.XmlNode} objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - interface ShapeLoadOptions { + interface XmlNodeCollectionLoadOptions { /** 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; /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - body?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - canvas?: Word.Interfaces.CanvasLoadOptions; + firstChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Returns the fill formatting of the shape. + * For EACH ITEM in the collection: Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - fill?: Word.Interfaces.ShapeFillLoadOptions; + lastChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * For EACH ITEM in the collection: Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - parentCanvas?: Word.Interfaces.ShapeLoadOptions; + nextSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * For EACH ITEM in the collection: Gets the parent document of this XML node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - parentGroup?: Word.Interfaces.ShapeLoadOptions; + ownerDocument?: Word.Interfaces.DocumentLoadOptions; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * For EACH ITEM in the collection: Gets the parent element of this XML node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; + parentNode?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the `TextFrame` object of the shape. + * For EACH ITEM in the collection: Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - textFrame?: Word.Interfaces.TextFrameLoadOptions; + previousSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Returns the text wrap formatting of the shape. + * For EACH ITEM in the collection: Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies whether a given shape can overlap other shapes. + * For EACH ITEM in the collection: Gets the name of the element without any prefix. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - allowOverlap?: boolean; + baseName?: boolean; /** - * Specifies a string that represents the alternative text associated with the shape. + * For EACH ITEM in the collection: Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - altTextDescription?: boolean; + hasChildNodes?: boolean; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * For EACH ITEM in the collection: Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - geometricShapeType?: boolean; + level?: boolean; /** - * The height, in points, of the shape. + * For EACH ITEM in the collection: Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - height?: boolean; + namespaceUri?: boolean; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * For EACH ITEM in the collection: Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - heightRelative?: boolean; + placeholderText?: boolean; /** - * Gets an integer that represents the shape identifier. + * For EACH ITEM in the collection: Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - id?: boolean; + text?: boolean; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * For EACH ITEM in the collection: Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - isChild?: boolean; + validationErrorText?: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * For EACH ITEM in the collection: Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - left?: boolean; + validationStatus?: boolean; + } + /** + * Represents a single XML node applied to the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface XmlNodeLoadOptions { /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + 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`). */ - leftRelative?: boolean; + $all?: boolean; /** - * Specifies if the aspect ratio of this shape is locked. + * Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + firstChild?: Word.Interfaces.XmlNodeLoadOptions; + /** + * Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + lastChild?: Word.Interfaces.XmlNodeLoadOptions; + /** + * Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + nextSibling?: Word.Interfaces.XmlNodeLoadOptions; + /** + * Gets the parent document of this XML node. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + ownerDocument?: Word.Interfaces.DocumentLoadOptions; + /** + * Gets the parent element of this XML node. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + parentNode?: Word.Interfaces.XmlNodeLoadOptions; + /** + * Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + previousSibling?: Word.Interfaces.XmlNodeLoadOptions; + /** + * Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets the name of the element without any prefix. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - lockAspectRatio?: boolean; + baseName?: boolean; /** - * The name of the shape. + * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - name?: boolean; + hasChildNodes?: boolean; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - relativeHorizontalPosition?: boolean; + level?: boolean; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - relativeHorizontalSize?: boolean; + namespaceUri?: boolean; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - relativeVerticalPosition?: boolean; + placeholderText?: boolean; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - relativeVerticalSize?: boolean; + text?: boolean; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - rotation?: boolean; + validationErrorText?: boolean; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - top?: boolean; + validationStatus?: boolean; + } + /** + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface HtmlDivisionLoadOptions { /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + 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`). */ - topRelative?: boolean; + $all?: boolean; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Gets a `Range` object that represents the portion of a document that's contained in this HTML division. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Specifies the left indent value (in points) for this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - type?: boolean; + leftIndent?: boolean; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Specifies the right indent (in points) for this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - visible?: boolean; + rightIndent?: boolean; /** - * The width, in points, of the shape. + * Specifies the amount of spacing (in points) after this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - width?: boolean; + spaceAfter?: boolean; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the spacing (in points) before this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - widthRelative?: boolean; + spaceBefore?: boolean; } /** - * Represents a shape group in the document. To get the corresponding {@link Word.Shape} object, use `ShapeGroup.shape`. + * Represents a collection of {@link Word.HtmlDivision} objects in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - interface ShapeGroupLoadOptions { + interface HtmlDivisionCollectionLoadOptions { /** 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; /** - * Gets the `Shape` object associated with the group. + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of a document that's contained in this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - shape?: Word.Interfaces.ShapeLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets an integer that represents the shape group identifier. + * For EACH ITEM in the collection: Specifies the left indent value (in points) for this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - id?: boolean; - } - /** - * Represents a canvas in the document. To get the corresponding {@link Word.Shape} object, use `Canvas.shape`. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface CanvasLoadOptions { + leftIndent?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies the right indent (in points) for this HTML division. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + rightIndent?: boolean; /** - * Gets the `Shape` object associated with the canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - shape?: Word.Interfaces.ShapeLoadOptions; + * For EACH ITEM in the collection: Specifies the amount of spacing (in points) after this HTML division. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + spaceAfter?: boolean; /** - * Gets an integer that represents the canvas identifier. + * For EACH ITEM in the collection: Specifies the spacing (in points) before this HTML division. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - id?: boolean; + spaceBefore?: boolean; } /** - * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - interface ShapeCollectionLoadOptions { + interface FrameLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - body?: Word.Interfaces.BodyLoadOptions; - /** - * For EACH ITEM in the collection: Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - canvas?: Word.Interfaces.CanvasLoadOptions; - /** - * For EACH ITEM in the collection: Returns the fill formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - fill?: Word.Interfaces.ShapeFillLoadOptions; - /** - * For EACH ITEM in the collection: Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - parentCanvas?: Word.Interfaces.ShapeLoadOptions; - /** - * For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - parentGroup?: Word.Interfaces.ShapeLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Gets the `TextFrame` object of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - textFrame?: Word.Interfaces.TextFrameLoadOptions; + * Specifies the height (in points) of the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + height?: boolean; /** - * For EACH ITEM in the collection: Returns the text wrap formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + heightRule?: boolean; /** - * For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - allowOverlap?: boolean; + horizontalDistanceFromText?: boolean; /** - * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the shape. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - altTextDescription?: boolean; + horizontalPosition?: boolean; /** - * For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies if the frame is locked. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - geometricShapeType?: boolean; + lockAnchor?: boolean; /** - * For EACH ITEM in the collection: The height, in points, of the shape. + * Specifies the relative horizontal position of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - height?: boolean; + relativeHorizontalPosition?: boolean; /** - * For EACH ITEM in the collection: The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the relative vertical position of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - heightRelative?: boolean; + relativeVerticalPosition?: boolean; /** - * For EACH ITEM in the collection: Gets an integer that represents the shape identifier. + * Specifies if document text wraps around the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - id?: boolean; + textWrap?: boolean; /** - * For EACH ITEM in the collection: Check whether this shape is a child of a group shape or a canvas shape. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - isChild?: boolean; + verticalDistanceFromText?: boolean; /** - * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - left?: boolean; + verticalPosition?: boolean; /** - * For EACH ITEM in the collection: The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the width (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - leftRelative?: boolean; + width?: boolean; /** - * For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked. + * Specifies the rule used to determine the width of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - lockAspectRatio?: boolean; + widthRule?: boolean; + } + /** + * Represents the collection of {@link Word.Frame} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface FrameCollectionLoadOptions { /** - * For EACH ITEM in the collection: The name of the shape. + 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; + /** + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the height (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - name?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * For EACH ITEM in the collection: Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - relativeHorizontalPosition?: boolean; + heightRule?: boolean; /** - * For EACH ITEM in the collection: The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * For EACH ITEM in the collection: Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - relativeHorizontalSize?: boolean; + horizontalDistanceFromText?: boolean; /** - * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * For EACH ITEM in the collection: Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - relativeVerticalPosition?: boolean; + horizontalPosition?: boolean; /** - * For EACH ITEM in the collection: The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * For EACH ITEM in the collection: Specifies if the frame is locked. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - relativeVerticalSize?: boolean; + lockAnchor?: boolean; /** - * For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * For EACH ITEM in the collection: Specifies the relative horizontal position of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - rotation?: boolean; + relativeHorizontalPosition?: boolean; /** - * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * For EACH ITEM in the collection: Specifies the relative vertical position of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - top?: boolean; + relativeVerticalPosition?: boolean; /** - * For EACH ITEM in the collection: The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * For EACH ITEM in the collection: Specifies if document text wraps around the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - topRelative?: boolean; + textWrap?: boolean; /** - * For EACH ITEM in the collection: Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * For EACH ITEM in the collection: Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - type?: boolean; + verticalDistanceFromText?: boolean; /** - * For EACH ITEM in the collection: Specifies if the shape is visible. Not applicable to inline shapes. + * For EACH ITEM in the collection: Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - visible?: boolean; + verticalPosition?: boolean; /** - * For EACH ITEM in the collection: The width, in points, of the shape. + * For EACH ITEM in the collection: Specifies the width (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ width?: boolean; /** - * For EACH ITEM in the collection: The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * For EACH ITEM in the collection: Specifies the rule used to determine the width of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - widthRelative?: boolean; + widthRule?: boolean; } /** - * Represents the fill formatting of a {@link Word.Shape} object. + * Represents a document library version. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - interface ShapeFillLoadOptions { + interface DocumentLibraryVersionLoadOptions { /** 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; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - backgroundColor?: boolean; - /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Gets any optional comments associated with this version of the shared document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - foregroundColor?: boolean; + comments?: boolean; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - transparency?: boolean; + modified?: boolean; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Gets the name of the user who last saved this version of the shared document to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - type?: boolean; + modifiedBy?: boolean; } /** - * Represents the text frame of a {@link Word.Shape} object. + * Represents the collection of {@link Word.DocumentLibraryVersion} objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - interface TextFrameLoadOptions { + interface DocumentLibraryVersionCollectionLoadOptions { /** 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; /** - * Specifies the automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - autoSizeSetting?: boolean; - /** - * Specifies the bottom margin, in points, of the text frame. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - bottomMargin?: boolean; - /** - * Returns `true` if the text frame contains text, otherwise, `false`. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - hasText?: boolean; - /** - * Specifies the left margin, in points, of the text frame. + * For EACH ITEM in the collection: Gets any optional comments associated with this version of the shared document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - leftMargin?: boolean; + comments?: boolean; /** - * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. + * For EACH ITEM in the collection: Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - noTextRotation?: boolean; + modified?: boolean; /** - * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * For EACH ITEM in the collection: Gets the name of the user who last saved this version of the shared document to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - orientation?: boolean; + modifiedBy?: boolean; + } + /** + * Represents a dropped capital letter in a Word document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface DropCapLoadOptions { /** - * Specifies the right margin, in points, of the text frame. + 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; + /** + * Gets the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - rightMargin?: boolean; + distanceFromText?: boolean; /** - * Specifies the top margin, in points, of the text frame. + * Gets the name of the font for the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - topMargin?: boolean; + fontName?: boolean; /** - * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Gets the height (in lines) of the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: boolean; + linesToDrop?: boolean; /** - * Determines whether lines break automatically to fit text inside the shape. + * Gets the position of the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.4] */ - wordWrap?: boolean; + position?: boolean; } /** - * Represents all the properties for wrapping text around a {@link Word.Shape}. + * Represents the list formatting characteristics of a range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - interface ShapeTextWrapLoadOptions { + interface ListFormatLoadOptions { /** 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; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + list?: Word.Interfaces.ListLoadOptions; + /** + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + /** + * Indicates whether the `ListFormat` object contains a single list. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - bottomDistance?: boolean; + isSingleList?: boolean; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - leftDistance?: boolean; + isSingleListTemplate?: boolean; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - rightDistance?: boolean; + listLevelNumber?: boolean; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - side?: boolean; + listString?: boolean; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Gets the type of the list for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.3] */ - topDistance?: boolean; + listType?: boolean; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - type?: boolean; - } - /** - * Represents a single item in a {@link Word.RepeatingSectionContentControl}. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface RepeatingSectionItemLoadOptions { - /** - 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`). + * [Api set: WordApiDesktop 1.3] */ - $all?: boolean; - /** - * Returns the range of this repeating section item, excluding the start and end tags. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeLoadOptions; + listValue?: boolean; } /** - * Represents the `DatePickerContentControl` object. + * Represents the fill formatting for a shape or text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface DatePickerContentControlLoadOptions { + interface FillFormatLoadOptions { /** 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; - /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeLoadOptions; + backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Specifies the appearance of the content control. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApiDesktop 1.3] */ - appearance?: boolean; + gradientAngle?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the gradient color type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - color?: boolean; + gradientColorType?: boolean; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. * * @remarks * [Api set: WordApiDesktop 1.3] */ - dateCalendarType?: boolean; + gradientDegree?: boolean; /** - * Specifies the format in which dates are displayed. + * Returns the gradient style for the fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - dateDisplayFormat?: boolean; + gradientStyle?: boolean; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks * [Api set: WordApiDesktop 1.3] */ - dateDisplayLocale?: boolean; + gradientVariant?: boolean; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApiDesktop 1.3] */ - dateStorageFormat?: boolean; + isVisible?: boolean; /** - * Gets the identification for the content control. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - id?: boolean; + pattern?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Returns the preset gradient type for the fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isTemporary?: boolean; + presetGradientType?: boolean; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the preset texture. * * @remarks * [Api set: WordApiDesktop 1.3] */ - level?: boolean; + presetTexture?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContentControl?: boolean; + rotateWithObject?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContents?: boolean; + textureAlignment?: boolean; /** - * Gets whether the placeholder text for the content control is being displayed. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - showingPlaceholderText?: boolean; + textureHorizontalScale?: boolean; /** - * Specifies a tag to identify the content control. + * Returns the name of the custom texture file for the fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - tag?: boolean; + textureName?: boolean; /** - * Specifies the title for the content control. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - title?: boolean; - } - /** - * Represents the `PictureContentControl` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface PictureContentControlLoadOptions { - /** - 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; - /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; - /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + textureOffsetX?: boolean; /** - * Specifies the appearance of the content control. + * Specifies the vertical offset of the texture. * * @remarks * [Api set: WordApiDesktop 1.3] */ - appearance?: boolean; + textureOffsetY?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies whether the texture is tiled. * * @remarks * [Api set: WordApiDesktop 1.3] */ - color?: boolean; + textureTile?: boolean; /** - * Returns the identification for the content control. + * Returns the texture type for the fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - id?: boolean; + textureType?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isTemporary?: boolean; + textureVerticalScale?: boolean; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApiDesktop 1.3] */ - level?: boolean; + transparency?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the fill format type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContentControl?: boolean; + type?: boolean; + } + /** + * Represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface GlowFormatLoadOptions { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - lockContents?: boolean; + $all?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - showingPlaceholderText?: boolean; + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + color?: Word.Interfaces.ColorFormatLoadOptions; /** - * Specifies a tag to identify the content control. + * Specifies the length of the radius for a glow effect. * * @remarks * [Api set: WordApiDesktop 1.3] */ - tag?: boolean; + radius?: boolean; /** - * Specifies the title for the content control. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApiDesktop 1.3] */ - title?: boolean; + transparency?: boolean; } /** - * Represents the `GroupContentControl` object. + * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; + for a shape with a border, this object contains formatting information for the shape's border. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface GroupContentControlLoadOptions { + interface LineFormatLoadOptions { /** 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeLoadOptions; + foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + * Specifies the length of the arrowhead at the beginning of the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + beginArrowheadLength?: boolean; /** - * Specifies the appearance of the content control. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - appearance?: boolean; + beginArrowheadStyle?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - color?: boolean; + beginArrowheadWidth?: boolean; /** - * Returns the identification for the content control. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - id?: boolean; + dashStyle?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isTemporary?: boolean; + endArrowheadLength?: boolean; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - level?: boolean; + endArrowheadStyle?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContentControl?: boolean; + endArrowheadWidth?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContents?: boolean; + insetPen?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApiDesktop 1.3] */ - showingPlaceholderText?: boolean; + isVisible?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApiDesktop 1.3] */ - tag?: boolean; + pattern?: boolean; /** - * Specifies the title for the content control. + * Specifies the line format style. * * @remarks * [Api set: WordApiDesktop 1.3] */ - title?: boolean; + style?: boolean; + /** + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + transparency?: boolean; + /** + * Specifies the thickness of the line in points. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + weight?: boolean; } /** - * Represents the `BuildingBlockGalleryContentControl` object. + * Represents the reflection formatting for a shape in Word. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface BuildingBlockGalleryContentControlLoadOptions { + interface ReflectionFormatLoadOptions { /** 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; - /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; - /** - * Specifies the appearance of the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - appearance?: boolean; - /** - * Specifies the category for the building block content control. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApiDesktop 1.3] */ - buildingBlockCategory?: boolean; + blur?: boolean; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - buildingBlockType?: boolean; + offset?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApiDesktop 1.3] */ - color?: boolean; + size?: boolean; /** - * Gets the identification for the content control. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApiDesktop 1.3] */ - id?: boolean; + transparency?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isTemporary?: boolean; + type?: boolean; + } + /** + * Represents the color formatting of a shape or text in Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface ColorFormatLoadOptions { /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - level?: boolean; + $all?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContentControl?: boolean; + brightness?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContents?: boolean; + objectThemeColor?: boolean; /** - * Gets if the placeholder text for the content control is being displayed. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - showingPlaceholderText?: boolean; + rgb?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApiDesktop 1.3] */ - tag?: boolean; + tintAndShade?: boolean; /** - * Specifies the title for the content control. + * Returns the shape color type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - title?: boolean; + type?: boolean; } /** - * Represents the `RepeatingSectionContentControl` object. + * Represents the shadow formatting for a shape or text in Word. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface RepeatingSectionContentControlLoadOptions { + interface ShadowFormatLoadOptions { /** 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; - /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - allowInsertDeleteSection?: boolean; - /** - * Specifies the appearance of the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - appearance?: boolean; + foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApiDesktop 1.3] */ - color?: boolean; + blur?: boolean; /** - * Returns the identification for the content control. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApiDesktop 1.3] */ - id?: boolean; + isVisible?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isTemporary?: boolean; + obscured?: boolean; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. * * @remarks * [Api set: WordApiDesktop 1.3] */ - level?: boolean; + offsetX?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContentControl?: boolean; + offsetY?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockContents?: boolean; + rotateWithShape?: boolean; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Specifies the width of the shadow. * * @remarks * [Api set: WordApiDesktop 1.3] */ - repeatingSectionItemTitle?: boolean; + size?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - showingPlaceholderText?: boolean; + style?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApiDesktop 1.3] */ - tag?: boolean; + transparency?: boolean; /** - * Specifies the title for the content control. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApiDesktop 1.3] */ - title?: boolean; + type?: boolean; } /** - * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * Represents a shape's three-dimensional formatting. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface FrameLoadOptions { + interface ThreeDimensionalFormatLoadOptions { /** 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; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - range?: Word.Interfaces.RangeLoadOptions; + contourColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks * [Api set: WordApiDesktop 1.3] */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + extrusionColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Specifies the height (in points) of the frame. + * Specifies the depth of the bottom bevel. * * @remarks * [Api set: WordApiDesktop 1.3] */ - height?: boolean; + bevelBottomDepth?: boolean; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies the inset size for the bottom bevel. * * @remarks * [Api set: WordApiDesktop 1.3] */ - heightRule?: boolean; + bevelBottomInset?: boolean; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks * [Api set: WordApiDesktop 1.3] */ - horizontalDistanceFromText?: boolean; + bevelBottomType?: boolean; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies the depth of the top bevel. * * @remarks * [Api set: WordApiDesktop 1.3] */ - horizontalPosition?: boolean; + bevelTopDepth?: boolean; /** - * Specifies if the frame is locked. + * Specifies the inset size for the top bevel. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockAnchor?: boolean; + bevelTopInset?: boolean; /** - * Specifies the relative horizontal position of the frame. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks * [Api set: WordApiDesktop 1.3] */ - relativeHorizontalPosition?: boolean; + bevelTopType?: boolean; /** - * Specifies the relative vertical position of the frame. + * Specifies the width of the contour of a shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - relativeVerticalPosition?: boolean; + contourWidth?: boolean; /** - * Specifies if document text wraps around the frame. + * Specifies the depth of the shape's extrusion. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textWrap?: boolean; + depth?: boolean; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks * [Api set: WordApiDesktop 1.3] */ - verticalDistanceFromText?: boolean; + extrusionColorType?: boolean; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - verticalPosition?: boolean; + fieldOfView?: boolean; /** - * Specifies the width (in points) of the frame. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks * [Api set: WordApiDesktop 1.3] */ - width?: boolean; + isPerspective?: boolean; /** - * Specifies the rule used to determine the width of the frame. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApiDesktop 1.3] */ - widthRule?: boolean; - } - /** - * Represents the collection of {@link Word.Frame} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface FrameCollectionLoadOptions { + isVisible?: boolean; /** - 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`). + * Specifies the angle of the lighting. + * + * @remarks + * [Api set: WordApiDesktop 1.3] */ - $all?: boolean; - /** - * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + lightAngle?: boolean; /** - * For EACH ITEM in the collection: Specifies the height (in points) of the frame. + * Returns a `PresetCamera` value that represents the camera presets. * * @remarks * [Api set: WordApiDesktop 1.3] */ - height?: boolean; + presetCamera?: boolean; /** - * For EACH ITEM in the collection: Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). * * @remarks * [Api set: WordApiDesktop 1.3] */ - heightRule?: boolean; + presetExtrusionDirection?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApiDesktop 1.3] */ - horizontalDistanceFromText?: boolean; + presetLighting?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApiDesktop 1.3] */ - horizontalPosition?: boolean; + presetLightingDirection?: boolean; /** - * For EACH ITEM in the collection: Specifies if the frame is locked. + * Specifies the intensity of the extrusion lighting. * * @remarks * [Api set: WordApiDesktop 1.3] */ - lockAnchor?: boolean; + presetLightingSoftness?: boolean; /** - * For EACH ITEM in the collection: Specifies the relative horizontal position of the frame. + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApiDesktop 1.3] */ - relativeHorizontalPosition?: boolean; + presetMaterial?: boolean; /** - * For EACH ITEM in the collection: Specifies the relative vertical position of the frame. + * Returns the preset extrusion format. * * @remarks * [Api set: WordApiDesktop 1.3] */ - relativeVerticalPosition?: boolean; + presetThreeDimensionalFormat?: boolean; /** - * For EACH ITEM in the collection: Specifies if document text wraps around the frame. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textWrap?: boolean; + projectText?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApiDesktop 1.3] */ - verticalDistanceFromText?: boolean; + rotationX?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApiDesktop 1.3] */ - verticalPosition?: boolean; + rotationY?: boolean; /** - * For EACH ITEM in the collection: Specifies the width (in points) of the frame. + * Specifies the z-axis rotation of the camera. * * @remarks * [Api set: WordApiDesktop 1.3] */ - width?: boolean; + rotationZ?: boolean; /** - * For EACH ITEM in the collection: Specifies the rule used to determine the width of the frame. + * Specifies the position on the z-axis for the shape. * * @remarks * [Api set: WordApiDesktop 1.3] */ - widthRule?: boolean; + z?: boolean; } /** - * Represents a document library version. + * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface DocumentLibraryVersionLoadOptions { + interface BibliographyLoadOptions { /** 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; /** - * Gets any optional comments associated with this version of the shared document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - comments?: boolean; - /** - * Gets the date and time at which this version of the shared document was last saved to the server. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - modified?: boolean; - /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Specifies the name of the active style to use for the bibliography. * * @remarks * [Api set: WordApiDesktop 1.3] */ - modifiedBy?: boolean; + bibliographyStyle?: boolean; } /** - * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * Represents a collection of {@link Word.Source} objects. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface DocumentLibraryVersionCollectionLoadOptions { + interface SourceCollectionLoadOptions { /** 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; /** - * For EACH ITEM in the collection: Gets any optional comments associated with this version of the shared document. + * For EACH ITEM in the collection: Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - comments?: boolean; + isCited?: boolean; /** - * For EACH ITEM in the collection: Gets the date and time at which this version of the shared document was last saved to the server. + * For EACH ITEM in the collection: Gets the tag of the source. * * @remarks * [Api set: WordApiDesktop 1.3] */ - modified?: boolean; + tag?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the user who last saved this version of the shared document to the server. + * For EACH ITEM in the collection: Gets the XML representation of the source. * * @remarks * [Api set: WordApiDesktop 1.3] */ - modifiedBy?: boolean; + xml?: boolean; } /** - * Represents the list formatting characteristics of a range. + * Represents an individual source, such as a book, journal article, or interview. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface ListFormatLoadOptions { + interface SourceLoadOptions { /** 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; /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - list?: Word.Interfaces.ListLoadOptions; - /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; - /** - * Indicates whether the `ListFormat` object contains a single list. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - isSingleList?: boolean; - /** - * Indicates whether the `ListFormat` object contains a single list template. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - isSingleListTemplate?: boolean; - /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - listLevelNumber?: boolean; - /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - listString?: boolean; + isCited?: boolean; /** - * Gets the type of the list for the `ListFormat` object. + * Gets the tag of the source. * * @remarks * [Api set: WordApiDesktop 1.3] */ - listType?: boolean; + tag?: boolean; /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * Gets the XML representation of the source. * * @remarks * [Api set: WordApiDesktop 1.3] */ - listValue?: boolean; + xml?: boolean; } /** - * Represents the fill formatting for a shape or text. + * Represents the page setup settings for a Word document or section. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface FillFormatLoadOptions { + interface PageSetupLoadOptions { /** 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; /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; - /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; - /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - gradientAngle?: boolean; + lineNumbering?: Word.Interfaces.LineNumberingLoadOptions; /** - * Gets the gradient color type. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gradientColorType?: boolean; + bookFoldPrinting?: boolean; /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * Specifies the number of pages for each booklet. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gradientDegree?: boolean; + bookFoldPrintingSheets?: boolean; /** - * Returns the gradient style for the fill. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gradientStyle?: boolean; + bookFoldReversePrinting?: boolean; /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - gradientVariant?: boolean; + bottomMargin?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the number of characters per line in the document grid. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isVisible?: boolean; + charsLine?: boolean; /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * Specifies whether the first page has a different header and footer. * * @remarks * [Api set: WordApiDesktop 1.3] */ - pattern?: boolean; + differentFirstPageHeaderFooter?: boolean; /** - * Returns the preset gradient type for the fill. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - presetGradientType?: boolean; + footerDistance?: boolean; /** - * Gets the preset texture. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks * [Api set: WordApiDesktop 1.3] */ - presetTexture?: boolean; + gutter?: boolean; /** - * Specifies whether the fill rotates with the shape. + * Specifies on which side the gutter appears in a document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - rotateWithObject?: boolean; + gutterPosition?: boolean; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureAlignment?: boolean; + gutterStyle?: boolean; /** - * Specifies the horizontal scaling factor for the texture fill. + * Specifies the distance between the header and the top of the page in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureHorizontalScale?: boolean; + headerDistance?: boolean; /** - * Returns the name of the custom texture file for the fill. + * Specifies the layout mode for the current document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureName?: boolean; + layoutMode?: boolean; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureOffsetX?: boolean; + leftMargin?: boolean; /** - * Specifies the vertical offset of the texture. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureOffsetY?: boolean; + linesPage?: boolean; /** - * Specifies whether the texture is tiled. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureTile?: boolean; + mirrorMargins?: boolean; /** - * Returns the texture type for the fill. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureType?: boolean; + oddAndEvenPagesHeaderFooter?: boolean; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApiDesktop 1.3] */ - textureVerticalScale?: boolean; + orientation?: boolean; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the page height in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - transparency?: boolean; + pageHeight?: boolean; /** - * Gets the fill format type. + * Specifies the page width in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - type?: boolean; - } - /** - * Represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface GlowFormatLoadOptions { - /** - 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; - /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - color?: Word.Interfaces.ColorFormatLoadOptions; + pageWidth?: boolean; /** - * Specifies the length of the radius for a glow effect. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApiDesktop 1.3] */ - radius?: boolean; + paperSize?: boolean; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - transparency?: boolean; - } - /** - * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; - for a shape with a border, this object contains formatting information for the shape's border. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface LineFormatLoadOptions { - /** - 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; - /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; - /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; + rightMargin?: boolean; /** - * Specifies the length of the arrowhead at the beginning of the line. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApiDesktop 1.3] */ - beginArrowheadLength?: boolean; + sectionDirection?: boolean; /** - * Specifies the style of the arrowhead at the beginning of the line. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApiDesktop 1.3] */ - beginArrowheadStyle?: boolean; + sectionStart?: boolean; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApiDesktop 1.3] */ - beginArrowheadWidth?: boolean; + showGrid?: boolean; /** - * Specifies the dash style for the line. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApiDesktop 1.3] */ - dashStyle?: boolean; + suppressEndnotes?: boolean; /** - * Specifies the length of the arrowhead at the end of the line. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApiDesktop 1.3] */ - endArrowheadLength?: boolean; + topMargin?: boolean; /** - * Specifies the style of the arrowhead at the end of the line. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApiDesktop 1.3] */ - endArrowheadStyle?: boolean; + twoPagesOnOne?: boolean; /** - * Specifies the width of the arrowhead at the end of the line. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApiDesktop 1.3] */ - endArrowheadWidth?: boolean; + verticalAlignment?: boolean; + } + /** + * Represents line numbers in the left margin or to the left of each newspaper-style column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface LineNumberingLoadOptions { /** - * Specifies if to draw lines inside a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - insetPen?: boolean; + $all?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isVisible?: boolean; + countBy?: boolean; /** - * Specifies the pattern applied to the line. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApiDesktop 1.3] */ - pattern?: boolean; + distanceFromText?: boolean; /** - * Specifies the line format style. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApiDesktop 1.3] */ - style?: boolean; + isActive?: boolean; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks * [Api set: WordApiDesktop 1.3] */ - transparency?: boolean; + restartMode?: boolean; /** - * Specifies the thickness of the line in points. + * Specifies the starting line number. * * @remarks * [Api set: WordApiDesktop 1.3] */ - weight?: boolean; + startingNumber?: boolean; } /** - * Represents the reflection formatting for a shape in Word. + * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. * * @remarks * [Api set: WordApiDesktop 1.3] */ - interface ReflectionFormatLoadOptions { + interface TextColumnCollectionLoadOptions { /** 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; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * For EACH ITEM in the collection: Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - blur?: boolean; + spaceAfter?: boolean; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * For EACH ITEM in the collection: Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApiDesktop 1.3] */ - offset?: boolean; + width?: boolean; + } + /** + * Represents a single text column in a section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ + interface TextColumnLoadOptions { /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - size?: boolean; + $all?: boolean; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApiDesktop 1.3] */ - transparency?: boolean; + spaceAfter?: boolean; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApiDesktop 1.3] */ - type?: boolean; + width?: boolean; } /** - * Represents the color formatting of a shape or text in Word. + * Represents a selected range or the insertion point in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] + * + * Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. */ - interface ColorFormatLoadOptions { + interface SelectionLoadOptions { /** 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; + $all?: boolean; + /** + * Returns the `Font` object that represents the character formatting of the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + font?: Word.Interfaces.FontLoadOptions; + /** + * Specifies a `Range` object that includes the formatted text in the range or selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + formattedText?: Word.Interfaces.RangeLoadOptions; + /** + * Returns the `Range` object for the portion of the document contained in the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns the `ShadingUniversal` object for the shading formatting for the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; + /** + * Specifies the ending character position of the selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + end?: boolean; + /** + * Specifies the width in which Word fits the text in the current selection. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + fitTextWidth?: boolean; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - brightness?: boolean; + hasNoProofing?: boolean; /** - * Specifies the theme color for a color format. + * Returns whether the selection in the specified window or pane is active. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - objectThemeColor?: boolean; + isActive?: boolean; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Specifies whether column selection mode is active. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - rgb?: boolean; + isColumnSelectModeActive?: boolean; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Returns whether the selection is at the end-of-row mark in a table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tintAndShade?: boolean; + isEndOfRowMark?: boolean; /** - * Returns the shape color type. + * Specifies whether Extend mode is active. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - type?: boolean; - } - /** - * Represents the shadow formatting for a shape or text in Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface ShadowFormatLoadOptions { + isExtendModeActive?: boolean; /** - 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`). + * Returns whether the insertion point is at the end of a line. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + isInsertionPointAtEndOfLine?: boolean; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; + * Specifies whether the beginning of the selection is active. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + isStartActive?: boolean; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Specifies whether Word has detected the language of the selected text. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - blur?: boolean; + languageDetected?: boolean; /** - * Specifies whether the object or the formatting applied to it is visible. + * Returns the language for the selection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isVisible?: boolean; + languageId?: boolean; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Returns the East Asian language for the selection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - obscured?: boolean; + languageIdFarEast?: boolean; /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - offsetX?: boolean; + languageIdOther?: boolean; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * Specifies the orientation of text in the selection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - offsetY?: boolean; + orientation?: boolean; /** - * Specifies whether to rotate the shadow when rotating the shape. + * Specifies the starting character position of the selection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - rotateWithShape?: boolean; + start?: boolean; /** - * Specifies the width of the shadow. + * Returns the number of characters in the story that contains the selection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - size?: boolean; + storyLength?: boolean; /** - * Specifies the type of shadow formatting to apply to a shape. + * Returns the story type for the selection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - style?: boolean; + storyType?: boolean; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the text in the selection. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - transparency?: boolean; + text?: boolean; /** - * Specifies the shape shadow type. + * Returns the selection type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ type?: boolean; } /** - * Represents a shape's three-dimensional formatting. + * Represents a collection of {@link Word.Range} objects that represents each character, word, or sentence. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - interface ThreeDimensionalFormatLoadOptions { + interface RangeScopedCollectionLoadOptions { /** 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; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. + * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - contourColor?: Word.Interfaces.ColorFormatLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - extrusionColor?: Word.Interfaces.ColorFormatLoadOptions; + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * Specifies the depth of the bottom bevel. + * For EACH ITEM in the collection: Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentBody?: Word.Interfaces.BodyLoadOptions; + /** + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + /** + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCell?: Word.Interfaces.TableCellLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + /** + * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; + /** + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bevelBottomDepth?: boolean; + bold?: boolean; /** - * Specifies the inset size for the bottom bevel. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bevelBottomInset?: boolean; + boldBidirectional?: boolean; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * For EACH ITEM in the collection: Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bevelBottomType?: boolean; + case?: boolean; /** - * Specifies the depth of the top bevel. + * For EACH ITEM in the collection: Specifies the character width of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bevelTopDepth?: boolean; + characterWidth?: boolean; /** - * Specifies the inset size for the top bevel. + * For EACH ITEM in the collection: Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bevelTopInset?: boolean; + combineCharacters?: boolean; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * For EACH ITEM in the collection: Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bevelTopType?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * Specifies the width of the contour of a shape. + * For EACH ITEM in the collection: Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - contourWidth?: boolean; + emphasisMark?: boolean; /** - * Specifies the depth of the shape's extrusion. + * For EACH ITEM in the collection: Specifies the ending character position of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - depth?: boolean; + end?: boolean; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * For EACH ITEM in the collection: Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - extrusionColorType?: boolean; + fitTextWidth?: boolean; /** - * Specifies the amount of perspective for a shape. + * For EACH ITEM in the collection: Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - fieldOfView?: boolean; + grammarChecked?: boolean; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - isPerspective?: boolean; + hasNoProofing?: boolean; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * For EACH ITEM in the collection: Specifies the highlight color for the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isVisible?: boolean; + highlightColorIndex?: boolean; /** - * Specifies the angle of the lighting. + * For EACH ITEM in the collection: Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - lightAngle?: boolean; + horizontalInVertical?: boolean; /** - * Returns a `PresetCamera` value that represents the camera presets. + * For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - presetCamera?: boolean; + hyperlink?: boolean; /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * For EACH ITEM in the collection: Specifies the ID for the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - presetExtrusionDirection?: boolean; + id?: boolean; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * For EACH ITEM in the collection: Checks whether the range length is zero. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - presetLighting?: boolean; + isEmpty?: boolean; /** - * Specifies the position of the light source relative to the extrusion. + * For EACH ITEM in the collection: Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - presetLightingDirection?: boolean; + isEndOfRowMark?: boolean; /** - * Specifies the intensity of the extrusion lighting. + * For EACH ITEM in the collection: Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - presetLightingSoftness?: boolean; + isTextVisibleOnScreen?: boolean; /** - * Specifies the extrusion surface material. + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - presetMaterial?: boolean; + italic?: boolean; /** - * Returns the preset extrusion format. + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - presetThreeDimensionalFormat?: boolean; + italicBidirectional?: boolean; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * For EACH ITEM in the collection: Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - projectText?: boolean; + kana?: boolean; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - rotationX?: boolean; + languageDetected?: boolean; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - rotationY?: boolean; + languageId?: boolean; /** - * Specifies the z-axis rotation of the camera. + * For EACH ITEM in the collection: Specifies an East Asian language for the range. * * @remarks * [Api set: WordApiDesktop 1.3] */ - rotationZ?: boolean; + languageIdFarEast?: boolean; /** - * Specifies the position on the z-axis for the shape. + * For EACH ITEM in the collection: Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApiDesktop 1.3] */ - z?: boolean; - } - /** - * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface BibliographyLoadOptions { - /** - 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; + languageIdOther?: boolean; /** - * Specifies the name of the active style to use for the bibliography. + * For EACH ITEM in the collection: Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bibliographyStyle?: boolean; - } - /** - * Represents a collection of {@link Word.Source} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface SourceCollectionLoadOptions { + showAll?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies if spelling has been checked throughout the range or document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + spellingChecked?: boolean; /** - * For EACH ITEM in the collection: Gets if the `Source` object has been cited in the document. + * For EACH ITEM in the collection: Specifies the starting character position of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isCited?: boolean; + start?: boolean; /** - * For EACH ITEM in the collection: Gets the tag of the source. + * For EACH ITEM in the collection: Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - tag?: boolean; + storyLength?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the source. + * For EACH ITEM in the collection: Gets the story type for the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - xml?: boolean; - } - /** - * Represents an individual source, such as a book, journal article, or interview. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface SourceLoadOptions { + storyType?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + style?: boolean; /** - * Gets if the `Source` object has been cited in the document. + * For EACH ITEM in the collection: Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.3] */ - isCited?: boolean; + styleBuiltIn?: boolean; /** - * Gets the tag of the source. + * For EACH ITEM in the collection: Gets the text of the range. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApi 1.1] */ - tag?: boolean; + text?: boolean; /** - * Gets the XML representation of the source. + * For EACH ITEM in the collection: Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - xml?: boolean; + twoLinesInOne?: boolean; } /** - * Represents the page setup settings for a Word document or section. + * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. + The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - interface PageSetupLoadOptions { + interface BookmarkLoadOptions { /** 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; /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - lineNumbering?: Word.Interfaces.LineNumberingLoadOptions; - /** - * Specifies whether Microsoft Word prints the document as a booklet. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - bookFoldPrinting?: boolean; - /** - * Specifies the number of pages for each booklet. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - bookFoldPrintingSheets?: boolean; - /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - bookFoldReversePrinting?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Specifies the ending character position of the bookmark. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - bottomMargin?: boolean; + end?: boolean; /** - * Specifies the number of characters per line in the document grid. + * Returns `true` if the bookmark is a table column. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - charsLine?: boolean; + isColumn?: boolean; /** - * Specifies whether the first page has a different header and footer. + * Returns `true` if the bookmark is empty. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - differentFirstPageHeaderFooter?: boolean; + isEmpty?: boolean; /** - * Specifies the distance between the footer and the bottom of the page in points. + * Returns the name of the `Bookmark` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - footerDistance?: boolean; + name?: boolean; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * Specifies the starting character position of the bookmark. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - gutter?: boolean; + start?: boolean; /** - * Specifies on which side the gutter appears in a document. + * Returns the story type for the bookmark. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - gutterPosition?: boolean; + storyType?: boolean; + } + /** + * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface BookmarkCollectionLoadOptions { /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - gutterStyle?: boolean; + $all?: boolean; /** - * Specifies the distance between the header and the top of the page in points. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - headerDistance?: boolean; + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the layout mode for the current document. + * For EACH ITEM in the collection: Specifies the ending character position of the bookmark. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - layoutMode?: boolean; + end?: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * For EACH ITEM in the collection: Returns `true` if the bookmark is a table column. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - leftMargin?: boolean; + isColumn?: boolean; /** - * Specifies the number of lines per page in the document grid. + * For EACH ITEM in the collection: Returns `true` if the bookmark is empty. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - linesPage?: boolean; + isEmpty?: boolean; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * For EACH ITEM in the collection: Returns the name of the `Bookmark` object. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - mirrorMargins?: boolean; + name?: boolean; /** - * Specifies whether odd and even pages have different headers and footers. + * For EACH ITEM in the collection: Specifies the starting character position of the bookmark. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - oddAndEvenPagesHeaderFooter?: boolean; + start?: boolean; /** - * Specifies the orientation of the page. + * For EACH ITEM in the collection: Returns the story type for the bookmark. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - orientation?: boolean; + storyType?: boolean; + } + /** + * Represents a single index. The `Index` object is a member of the {@link Word.IndexCollection}. The `IndexCollection` includes all the + indexes in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + interface IndexLoadOptions { /** - * Specifies the page height in points. - * - * @remarks - * [Api set: WordApiDesktop 1.3] + 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`). */ - pageHeight?: boolean; + $all?: boolean; /** - * Specifies the page width in points. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - pageWidth?: boolean; + * Returns a `Range` object that represents the portion of the document that is contained within the index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the paper size of the page. + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - paperSize?: boolean; + filter?: boolean; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - rightMargin?: boolean; + headingSeparator?: boolean; /** - * Specifies the reading order and alignment for the specified sections. + * Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sectionDirection?: boolean; + indexLanguage?: boolean; /** - * Specifies the type of section break for the specified object. + * Gets the number of columns for each page of the index. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - sectionStart?: boolean; + numberOfColumns?: boolean; /** - * Specifies whether to show the grid. + * Specifies if page numbers are aligned with the right margin in the index. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - showGrid?: boolean; + rightAlignPageNumbers?: boolean; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - suppressEndnotes?: boolean; + separateAccentedLetterHeadings?: boolean; /** - * Specifies the top margin of the page in points. + * Specifies the sorting criteria for the index. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - topMargin?: boolean; + sortBy?: boolean; /** - * Specifies whether to print two pages per sheet. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - twoPagesOnOne?: boolean; + tabLeader?: boolean; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Gets the index type. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - verticalAlignment?: boolean; + type?: boolean; } /** - * Represents line numbers in the left margin or to the left of each newspaper-style column. + * A collection of {@link Word.Index} objects that represents all the indexes in the document. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - interface LineNumberingLoadOptions { + interface IndexCollectionLoadOptions { /** 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; /** - * Specifies the numeric increment for line numbers. + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that is contained within the index. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - countBy?: boolean; + filter?: boolean; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * For EACH ITEM in the collection: Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - distanceFromText?: boolean; + headingSeparator?: boolean; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * For EACH ITEM in the collection: Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - isActive?: boolean; + indexLanguage?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * For EACH ITEM in the collection: Gets the number of columns for each page of the index. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - restartMode?: boolean; + numberOfColumns?: boolean; /** - * Specifies the starting line number. + * For EACH ITEM in the collection: Specifies if page numbers are aligned with the right margin in the index. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - startingNumber?: boolean; - } - /** - * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ - interface TextColumnCollectionLoadOptions { + rightAlignPageNumbers?: boolean; /** - 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`). + * For EACH ITEM in the collection: Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). + * + * @remarks + * [Api set: WordApiDesktop 1.4] */ - $all?: boolean; + separateAccentedLetterHeadings?: boolean; /** - * For EACH ITEM in the collection: Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Specifies the sorting criteria for the index. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spaceAfter?: boolean; + sortBy?: boolean; /** - * For EACH ITEM in the collection: Specifies the width, in points, of the specified text columns. + * For EACH ITEM in the collection: Specifies the leader character between entries in the index and their associated page numbers. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - width?: boolean; + tabLeader?: boolean; + /** + * For EACH ITEM in the collection: Gets the index type. + * + * @remarks + * [Api set: WordApiDesktop 1.4] + */ + type?: boolean; } /** - * Represents a single text column in a section. + * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - interface TextColumnLoadOptions { + interface ListTemplateCollectionLoadOptions { /** 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; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Specifies the name of the list template. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.4] */ - spaceAfter?: boolean; + name?: boolean; /** - * Specifies the width, in points, of the specified text columns. + * For EACH ITEM in the collection: Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApiDesktop 1.3] + * [Api set: WordApiDesktop 1.1] */ - width?: boolean; + outlineNumbered?: boolean; } } }