diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 82563a425459bf..d30c1cb03b9465 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -102781,6 +102781,14 @@ declare namespace Word { * [Api set: WordApi 1.1] */ readonly body: Word.Body; + /** + * Returns a `BookmarkCollection` object that represents all the bookmarks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly bookmarks: Word.BookmarkCollection; /** * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * @@ -102819,6 +102827,14 @@ declare namespace Word { * @beta */ readonly hyperlinks: Word.HyperlinkCollection; + /** + * Returns an `IndexCollection` object that represents all the indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly indexes: Word.IndexCollection; /** * Returns a `PageSetup` object that's associated with the document. * @@ -103804,6 +103820,22 @@ declare namespace 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; + /** + * Gets a `LinkFormat` object that represents the link options of the field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + readonly oleFormat: Word.OleFormat; /** * Gets the parent body of the field. * @@ -103912,6 +103944,22 @@ declare namespace Word { 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.Field): void; + /** + * Copies the field to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyToClipboard(): void; + /** + * Removes the field from the document and places it on the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cut(): void; /** * Deletes the field. * @@ -103919,6 +103967,14 @@ declare namespace Word { * [Api set: WordApi 1.5] */ delete(): void; + /** + * Clicks the field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + doClick(): void; /** * Gets the next field. Throws an `ItemNotFound` error if this field is the last one. * @@ -103951,6 +104007,14 @@ declare namespace Word { * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Replaces the field with its most recent result. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unlink(): void; /** * Updates the field. * @@ -103958,6 +104022,14 @@ declare namespace Word { * [Api set: WordApi 1.5] */ updateResult(): void; + /** + * 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 + */ + updateSource(): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -105173,6 +105245,123 @@ declare namespace Word { */ toJSON(): Word.Interfaces.InlinePictureCollectionData; } + /** + * Represents the linking characteristics for an OLE object or picture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 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 + */ + isAutoUpdated: boolean; + /** + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLocked: boolean; + /** + * Specifies if the linked picture is saved with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + 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 + */ + readonly sourcePath: string; + /** + * Gets the link type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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.LinkFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LinkFormat): void; + /** + * Breaks the link between the source file and the OLE object, picture, or linked field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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.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.LinkFormat; + /** + * 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.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.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.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.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.LinkFormatData; + } /** * Contains a collection of {@link Word.Paragraph} objects. * @@ -105985,6 +106174,185 @@ declare namespace Word { */ toJSON(): Word.Interfaces.NoteItemCollectionData; } + /** + * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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; + /** + * Specifies the class type for the specified OLE object, picture, or field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classType: string; + /** + * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconIndex: number; + /** + * Specifies the text displayed below the icon for the OLE object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconLabel: string; + /** + * Specifies the program file in which the icon for the OLE object is stored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + readonly iconPath: string; + /** + * Gets whether the specified object is displayed as an icon. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + readonly label: string; + /** + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly progID: 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.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; + /** + * Activates the `OleFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + * + * @param classType The class type to activate as. + */ + activateAs(classType: string): void; + /** + * Requests that the OLE object perform one of its available verbs. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param verbIndex Optional. The index of the verb to perform. + */ + doVerb(verbIndex: Word.OleVerb): void; + /** + * Requests that the OLE object perform one of its available verbs. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param verbIndex Optional. The index of the verb to perform. + */ + doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void; + /** + * Opens the OLE object for editing in the application it was created in. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + edit(): void; + /** + * Opens the `OleFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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.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.OleFormat; + /** + * 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.OleFormat; + /** + * 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.OleFormat; + /** + * 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.OleFormat; + /** + * 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 page in the document. `Page` objects manage the page layout and content. * @@ -106255,6 +106623,103 @@ declare namespace Word { */ toJSON(): Word.Interfaces.PaneCollectionData; } + /** + * The options that define whether to save changes before closing and whether to route the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface WindowScrollOptions { + /** + * 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 BETA (PREVIEW ONLY)] + * @beta + */ + down?: number; + /** + * 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 BETA (PREVIEW ONLY)] + * @beta + */ + left?: number; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right?: number; + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + up?: number; + } + /** + * The options for scrolling through the specified pane or window page by page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface WindowPageScrollOptions { + /** + * 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + down?: number; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + up?: number; + } /** * Represents the window that displays the document. A window can be split to contain multiple reading panes. * @@ -106271,6 +106736,14 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ readonly activePane: Word.Pane; + /** + * Gets the next document window in the collection of open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly next: Word.Window; /** * Gets the collection of panes in the window. * @@ -106278,6 +106751,340 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ readonly panes: Word.PaneCollection; + /** + * Gets the previous document window in the collection open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly previous: Word.Window; + /** + * Gets the `View` object that represents the view for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly view: Word.View; + /** + * Specifies whether rulers are displayed for the window or pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areRulersDisplayed: boolean; + /** + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + caption: string; + /** + * Specifies the height of the window (in points). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly height: number; + /** + * Specifies the horizontal scroll position as a percentage of the document width. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalPercentScrolled: number; + /** + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + readonly index: number; + /** + * Specifies whether the window is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isActive: boolean; + /** + * Specifies whether the document map is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + isEnvelopeVisible: boolean; + /** + * Specifies whether a horizontal scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + isRightRulerDisplayed: boolean; + /** + * Specifies whether the window is split into multiple panes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isSplit: boolean; + /** + * Specifies whether a vertical ruler is displayed for the window or pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVerticalRulerDisplayed: boolean; + /** + * Specifies whether a vertical scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVerticalScrollBarDisplayed: boolean; + /** + * Specifies whether the window is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible: boolean; + /** + * Specifies the horizontal position of the window, measured in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly left: number; + /** + * Specifies how Microsoft Word displays source documents after a compare and merge process. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + /** + * Specifies the vertical split percentage for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + splitVertical: number; + /** + * Specifies the width of the style area in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + styleAreaWidth: number; + /** + * Specifies the vertical position of the document window, in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly top: number; + /** + * Gets the window type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + readonly usableWidth: number; + /** + * Specifies the vertical scroll position as a percentage of the document length. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalPercentScrolled: number; + /** + * Specifies the width of the document window, in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly width: number; + /** + * Gets an integer that represents the position of the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + 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; + /** + * Activates the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + activate(): void; + /** + * Closes the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options The options that define whether to save changes before closing and whether to route the document. + */ + close(options?: Word.WindowCloseOptions): void; + /** + * Scrolls the window by the specified number of screens. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options The options for scrolling the window by the specified number of screens. If no options are specified, the window is scrolled down one screen. + */ + largeScroll(options?: Word.WindowScrollOptions): void; + /** + * Scrolls through the window page by page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options The options for scrolling through the window page by page. + */ + pageScroll(options?: Word.WindowPageScrollOptions): void; + /** + * Sets the focus of the document window to the body of an email message. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + * + * @param options 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. + */ + smallScroll(options?: Word.WindowScrollOptions): void; + /** + * Shows or hides the ribbon. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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.WindowLoadOptions): Word.Window; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -106332,6 +107139,12 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ 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.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. * @@ -106494,6 +107307,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; + /** + * Gets a `Range` object that represents the portion of the document that's contained within the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; /** * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * @@ -106653,6 +107474,14 @@ declare namespace Word { * [Api set: WordApi 1.1] */ clear(): void; + /** + * Removes any spacing before the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + closeUp(): void; /** * Deletes the paragraph and its content from the document. * @@ -106795,6 +107624,34 @@ declare namespace Word { * [Api set: WordApi 1.6] */ getTrackedChanges(): Word.TrackedChangeCollection; + /** + * Indents the paragraph by one level. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indent(): void; + /** + * Indents the paragraph by a specified number of characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of characters for the indent. + */ + indentCharacterWidth(count: number): void; + /** + * Indents the first line of the paragraph by the specified number of characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of characters for the first line indent. + */ + indentFirstLineCharacterWidth(count: number): void; /** * Inserts annotations on this Paragraph object. * @@ -106952,6 +107809,98 @@ declare namespace Word { * @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; + /** + * Joins a list paragraph with the closest list above or below this paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + joinList(): void; + /** + * Returns a `Paragraph` object that represents the next paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count Optional. The number of paragraphs to move forward. + */ + next(count: number): Word.Paragraph; + /** + * Toggles the spacing before the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + openOrCloseUp(): void; + /** + * Sets spacing before the paragraph to 12 points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + openUp(): void; + /** + * Removes one level of indent for the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outdent(): void; + /** + * Applies the next heading level style (Heading 1 through Heading 8) to the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineDemote(): void; + /** + * Demotes the paragraph to body text by applying the Normal style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineDemoteToBody(): void; + /** + * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlinePromote(): void; + /** + * Returns the previous paragraph as a `Paragraph` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count Optional. The number of paragraphs to move backward. + */ + previous(count: number): Word.Paragraph; + /** + * Removes manual paragraph formatting (formatting not applied using a style). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reset(): void; + /** + * Resets the paragraph that uses custom list levels to the original level settings. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + resetAdvanceTo(): void; /** * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects. * @@ -106988,6 +107937,46 @@ declare namespace Word { * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Selects the number or bullet in a list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + separateList(): void; + /** + * Sets the paragraph to single spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space1(): void; + /** + * Sets the paragraph to 1.5-line spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space1Pt5(): void; + /** + * Sets the paragraph to double spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space2(): void; /** * Splits the paragraph into child ranges by using delimiters. * @@ -107006,6 +107995,26 @@ declare namespace Word { * [Api set: WordApi 1.3] */ startNewList(): Word.List; + /** + * Sets a hanging indent to a specified number of tab stops. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of tab stops for the hanging indent. + */ + tabHangingIndent(count: number): void; + /** + * Sets the left indent for the paragraph to a specified number of tab stops. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @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. * @@ -107102,6 +108111,32 @@ declare namespace Word { context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.Paragraph[]; + /** + * Returns a `Paragraph` object that represents a new, blank paragraph added to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range before which you want the new paragraph to be added. The new paragraph doesn't replace the range. + */ + add(range: Word.Range): Word.Paragraph; + /** + * Removes any spacing before the specified paragraphs. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + closeUp(): void; + /** + * Decreases the spacing before and after paragraphs in six-point increments. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + decreaseSpacing(): void; /** * Gets the first paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. * @@ -107131,15 +108166,143 @@ declare namespace Word { */ getLastOrNullObject(): Word.Paragraph; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Increases 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection; + increaseSpacing(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Indents the paragraphs by one level. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indent(): void; + /** + * Indents the paragraphs in the collection by the specified number of characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of characters by which the specified paragraphs are to be indented. + */ + indentCharacterWidth(count: number): void; + /** + * Indents the first line of the paragraphs in the collection by the specified number of characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of characters by which the first line of each specified paragraph is to be indented. + */ + indentFirstLineCharacterWidth(count: number): void; + /** + * Toggles spacing before paragraphs. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + openOrCloseUp(): void; + /** + * Sets spacing before the specified paragraphs to 12 points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + openUp(): void; + /** + * Removes one level of indent for the paragraphs. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + outlineDemote(): void; + /** + * Demotes the specified paragraphs to body text by applying the Normal style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + outlinePromote(): void; + /** + * Sets the specified paragraphs to single spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space1(): void; + /** + * Sets the specified paragraphs to 1.5-line spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space1Pt5(): void; + /** + * Sets the specified paragraphs to double spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space2(): void; + /** + * Sets a hanging indent to the specified number of tab stops. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). + */ + tabHangingIndent(count: number): void; + /** + * Sets the left indent for the specified paragraphs to the specified number of tab stops. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). + */ + 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.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.ParagraphCollection; /** @@ -107321,6 +108484,14 @@ declare namespace Word { 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; + /** + * Returns a `BookmarkCollection` object that represents all the bookmarks in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly bookmarks: Word.BookmarkCollection; /** * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * @@ -107505,6 +108676,86 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly tables: Word.TableCollection; + /** + * Specifies whether the range is formatted as bold. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + 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 + */ + characterWidth: Word.CharacterWidth | "Half" | "Full"; + /** + * Specifies if the range contains combined characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + readonly disableCharacterSpaceGrid: boolean; + /** + * Specifies the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + fitTextWidth: number; + /** + * Specifies if a grammar check has been run on the range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grammarChecked: boolean; /** * Specifies the proofing status (spelling and grammar checking) of the range. * @@ -107513,6 +108764,22 @@ declare namespace Word { * @beta */ hasNoProofing: boolean; + /** + * Specifies the highlight color for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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. * @@ -107520,6 +108787,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ hyperlink: string; + /** + * Specifies the ID for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id: string; /** * Checks whether the range length is zero. * @@ -107527,6 +108802,46 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly isEmpty: boolean; + /** + * 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 + */ + readonly isEndOfRowMark: boolean; + /** + * Gets whether the text in the range is visible on the screen. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isTextVisibleOnScreen: boolean; + /** + * Specifies if the font or range is formatted as italic. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + readonly italicBidirectional: boolean; + /** + * Specifies whether the range of Japanese language text is hiragana or katakana. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kana: Word.Kana | "Katakana" | "Hiragana"; /** * Specifies whether Microsoft Word has detected the language of the text in the range. * @@ -107559,6 +108874,46 @@ declare namespace Word { * @beta */ 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showAll: boolean; + /** + * Specifies if spelling has been checked throughout the range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spellingChecked: boolean; + /** + * Specifies the starting character position of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start: number; + /** + * Gets the number of characters in the story that contains the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyLength: number; + /** + * Gets the story type for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** * 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. * @@ -107580,6 +108935,22 @@ declare namespace Word { * [Api set: WordApi 1.1] */ readonly text: string; + /** + * 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 + */ + twoLinesInOne: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + /** + * Specifies the type of underline applied to the range. + * + * @remarks + * [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"; /** * 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. @@ -109958,6 +111329,225 @@ declare namespace Word { */ toJSON(): Word.Interfaces.TableStyleData; } + /** + * Represents a tab stop in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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; + /** + * Gets the next tab stop in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly next: Word.TabStop; + /** + * Gets the previous tab stop in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly previous: Word.TabStop; + /** + * Gets a `TabAlignment` value that represents the alignment for the tab stop. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + readonly customTab: boolean; + /** + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + readonly position: number; + /** + * Removes this custom tab stop. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clear(): 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.TabStopLoadOptions): Word.TabStop; + /** + * 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.TabStop; + /** + * 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.TabStop; + /** + * 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.TabStop; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param position The position of the tab stop. + * @param options Optional. The options to further configure the new tab stop. + */ + add(position: number, options?: Word.TabStopAddOptions): Word.TabStop; + /** + * Returns the next `TabStop` object to the right of the specified position. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param Position The position to check. + */ + after(Position: number): Word.TabStop; + /** + * Returns the next `TabStop` object to the left of the specified position. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param Position The position to check. + */ + before(Position: number): Word.TabStop; + /** + * Clears all the custom tab stops from the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearAll(): void; + /** + * Gets a `TabStop` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `TabStop` object. + */ + getItem(index: number): Word.TabStop; + /** + * 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.TabStopCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TabStopCollection; + /** + * 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.TabStopCollection; + /** + * 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.TabStopCollection; + /** + * 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.TabStopCollection; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TabStopAddOptions { + /** + * If provided, specifies the alignment of the tab stop. The default value is `left`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } /** * Contains the collection of the document's Table objects. * @@ -111470,6 +113060,545 @@ declare namespace Word { */ toJSON(): Word.Interfaces.TrackedChangeCollectionData; } + /** + * 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 + */ + 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; + /** + * Gets the instance of a `RevisionsFilter` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly revisionsFilter: Word.RevisionsFilter; + /** + * Specifies whether all nonprinting characters are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areBackgroundsDisplayed: boolean; + /** + * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly areBookmarksIndicated: boolean; + /** + * Specifies whether Microsoft Word displays the comments in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + 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 + */ + 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 + */ + areEditableRangesShaded: boolean; + /** + * Specifies whether field codes are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areFormatChangesDisplayed: boolean; + /** + * Specifies whether handwritten ink annotations are shown or hidden. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + 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 + */ + readonly areObjectAnchorsDisplayed: boolean; + /** + * Gets whether Microsoft Word displays optional line breaks. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly areOptionalBreaksDisplayed: boolean; + /** + * Gets whether optional hyphens are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly areOptionalHyphensDisplayed: boolean; + /** + * Gets whether other authors' presence should be visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + readonly arePageBoundariesDisplayed: boolean; + /** + * Gets whether paragraph marks are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly areParagraphsMarksDisplayed: boolean; + /** + * Gets whether blank boxes are displayed as placeholders for pictures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areRevisionsAndCommentsDisplayed: boolean; + /** + * Gets whether space characters are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly areSpacesIndicated: boolean; + /** + * Specifies whether table gridlines are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areTableGridlinesDisplayed: boolean; + /** + * Gets whether tab characters are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + readonly areTextBoundariesDisplayed: boolean; + /** + * Specifies the column width in Reading mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + /** + * Gets on-screen shading for fields. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + isDraft: boolean; + /** + * Specifies whether only the first line of body text is shown in outline view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFirstLineOnlyDisplayed: boolean; + /** + * Specifies whether character formatting is visible in outline view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFormatDisplayed: boolean; + /** + * Specifies whether the window is in full-screen view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFullScreen: boolean; + /** + * Gets whether text formatted as hidden text is displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isHiddenTextDisplayed: boolean; + /** + * Gets whether highlight formatting is displayed and printed with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isHighlightingDisplayed: boolean; + /** + * Specifies whether the document is in conflict mode view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isInConflictMode: boolean; + /** + * Specifies whether Microsoft Word is in Panning mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isInPanning: boolean; + /** + * Specifies whether the document is being viewed in reading layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isInReadingLayout: boolean; + /** + * Specifies whether mail merge data is displayed instead of mail merge fields. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + isMainTextLayerVisible: boolean; + /** + * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + isReadingLayoutActualView: boolean; + /** + * Specifies whether XML tags are visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isXmlMarkupVisible: boolean; + /** + * Specifies the display mode for tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + /** + * Specifies the page color in Reading mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; + /** + * Specifies the page movement type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; + /** + * Specifies the width of the revision balloons. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + revisionsBalloonWidth: number; + /** + * Specifies how Microsoft Word measures the width of revision balloons. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + /** + * Specifies the document element displayed in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + /** + * 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.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; + /** + * Collapses all the headings in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + collapseAllHeadings(): void; + /** + * Collapses the text under the selection or the specified range by one heading level. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range A `Range` object that specifies the range to collapse. + */ + collapseOutline(range: Word.Range): void; + /** + * Expands all the headings in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + expandAllHeadings(): void; + /** + * Expands the text under the selection by one heading level. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range A `Range` object that specifies the range to expand. + */ + expandOutline(range: Word.Range): void; + /** + * 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 + */ + 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 + */ + previousHeaderFooter(): void; + /** + * Switches between showing all text (headings and body text) and showing only headings. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + * + * @param level The heading level to show. + */ + showHeading(level: 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.ViewLoadOptions): Word.View; + /** + * 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.View; + /** + * 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.View; + /** + * 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.View; + /** + * 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.View; + /** + * 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. * @@ -112393,6 +114522,206 @@ declare namespace Word { */ 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 BETA (PREVIEW ONLY)] + * @beta + */ + isVisible: 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.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; + /** + * 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.ReviewerLoadOptions): Word.Reviewer; + /** + * 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.Reviewer; + /** + * 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.Reviewer; + /** + * 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.Reviewer; + /** + * 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.Reviewer; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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[]; + /** + * Returns a `Reviewer` object that represents the specified item in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The index of the item to retrieve. + */ + getItem(index: number): 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. + */ + load(options?: Word.Interfaces.ReviewerCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReviewerCollection; + /** + * 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.ReviewerCollection; + /** + * 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.ReviewerCollection; + /** + * 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.ReviewerCollection; + /** + * 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.ReviewerCollection; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + view: Word.RevisionsView | "Final" | "Original"; + /** + * 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.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; + /** + * Shows or hides all revisions in the document that contain comments and tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + toggleShowAllReviewers(): 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.RevisionsFilterLoadOptions): Word.RevisionsFilter; + /** + * 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.RevisionsFilter; + /** + * 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.RevisionsFilter; + /** + * 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.RevisionsFilter; + /** + * 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.RevisionsFilter; + /** + * 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.RepeatingSectionControlControl}. * @@ -112523,9 +114852,9 @@ declare namespace Word { */ untrack(): Word.RepeatingSectionItemCollection; /** - * 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. - */ + * 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; }; @@ -112750,9 +115079,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -114546,70 +116875,163 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the content control that raised contentControlSelectionChanged event. + * Represents a dropped capital letter in a Word document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ContentControlSelectionChangedEventArgs { + 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; /** - * The event type. See Word.EventType for details. + * Gets the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly distanceFromText: number; /** - * Gets the content control IDs. + * Gets the name of the font for the dropped capital letter. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + readonly fontName: string; /** - * The source of the event. It can be local or remote (through coauthoring). + * Gets the height (in lines) of the dropped capital letter. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + readonly linesToDrop: number; + /** + * Gets the position of the dropped capital letter. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; + /** + * Removes the dropped capital letter formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clear(): void; + /** + * Formats the first character in the specified paragraph as a dropped capital letter. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enable(): 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.DropCapLoadOptions): Word.DropCap; + /** + * 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.DropCap; + /** + * 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.DropCap; + /** + * 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.DropCap; + /** + * 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.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; } /** - * Provides information about the paragraphs that raised the paragraphAdded event. + * Provides information about the content control that raised contentControlSelectionChanged event. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - interface ParagraphAddedEventArgs { + interface ContentControlSelectionChangedEventArgs { /** - * The source of the event. It can be local or remote (through coauthoring). + * The event type. See Word.EventType for details. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - source: Word.EventSource | "Local" | "Remote"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * The event type. See Word.EventType for details. + * Gets the content control IDs. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + ids: 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. + * The source of the event. It can be local or remote (through coauthoring). * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - uniqueLocalIds: string[]; + source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the paragraphs that raised the paragraphChanged event. + * Provides information about the paragraphs that raised the paragraphAdded event. * * @remarks * [Api set: WordApi 1.6] */ - interface ParagraphChangedEventArgs { + interface ParagraphAddedEventArgs { + /** + * The source of the event. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.6] + */ + source: Word.EventSource | "Local" | "Remote"; + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.6] + */ + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "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[]; + } + /** + * Provides information about the paragraphs that raised the paragraphChanged event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface ParagraphChangedEventArgs { /** * The source of the event. It can be local or remote (through coauthoring). * @@ -115868,6 +118290,50 @@ 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", + } /** * @remarks * [Api set: WordApi 1.3] @@ -121168,6 +123634,29 @@ 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. * @@ -123141,6 +125630,136 @@ declare namespace Word { */ document = "document", } + /** + * Specifies the type of link. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LinkType { + /** + * OLE object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ole = "Ole", + /** + * Picture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + picture = "Picture", + /** + * Text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text = "Text", + /** + * Reference library. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reference = "Reference", + /** + * Include file. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + include = "Include", + /** + * Import file. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + import = "Import", + /** + * Dynamic Data Exchange. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dde = "Dde", + /** + * Automatic DDE. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ddeAuto = "DdeAuto", + /** + * Microsoft Excel chart. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chart = "Chart", + } + /** + * Specifies the action associated with the verb that the OLE object should perform. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum OleVerb { + /** + * Performs the verb that is invoked when the user double-clicks the object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + show = "Show", + /** + * Opens the object in a separate window. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + open = "Open", + /** + * Removes the object's user interface from view. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + 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 + */ + discardUndoState = "DiscardUndoState", + } /** * Represents the list formatting characteristics of a range. * @@ -123402,9 +126021,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -123875,9 +126494,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -124049,9 +126668,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -124142,9 +126761,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -124235,9 +126854,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -124397,9 +127016,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -124777,9 +127396,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -129565,12663 +132184,17977 @@ declare namespace Word { toJSON(): Word.Interfaces.TextColumnData; } /** - * Specifies the direction in which text flows from one text column to the next. + * Specifies the case of the text in the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum FlowDirection { + enum CharacterCase { /** - * Text flows from left to right. + * Specifies the next case. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + next = "Next", /** - * Text flows from right to left. + * Specifies lowercase. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", - } - /** - * Specifies where the gutter appears in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GutterPosition { + lower = "Lower", /** - * The gutter appears on the left side of the document. + * Specifies uppercase. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + upper = "Upper", /** - * The gutter appears on the right side of the document. + * Specifies title case for each word. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + titleWord = "TitleWord", /** - * The gutter appears at the top of the document. + * Specifies title case for the sentence. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + titleSentence = "TitleSentence", + /** + * Specifies toggle case. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + toggle = "Toggle", + /** + * Specifies half-width characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + halfWidth = "HalfWidth", + /** + * Specifies full-width characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fullWidth = "FullWidth", + /** + * Specifies Katakana characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + katakana = "Katakana", + /** + * Specifies Hiragana characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hiragana = "Hiragana", } /** - * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. + * Specifies the character width of the text in the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum GutterStyle { + enum CharacterWidth { /** - * Gutter style for bidirectional text flow. This is mainly right to left. + * Specifies half-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectional = "Bidirectional", + half = "Half", /** - * Gutter style for Latin text flow. This is mainly left to right. + * Specifies full-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latin = "Latin", + full = "Full", } /** - * Specifies how text is laid out in the layout mode for the current document. + * Specifies the seek view options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum LayoutMode { + enum SeekView { /** - * Default layout mode. + * Main document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + mainDocument = "MainDocument", /** - * Grid layout mode. + * Primary header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid = "Grid", + primaryHeader = "PrimaryHeader", /** - * Line grid layout mode. + * First page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineGrid = "LineGrid", + firstPageHeader = "FirstPageHeader", /** - * Genko layout mode. + * Even pages header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - genko = "Genko", - } - /** - * Specifies the numbering rule to apply. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberingRule { + evenPagesHeader = "EvenPagesHeader", /** - * Restart numbering continuously. + * Primary footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartContinuous = "RestartContinuous", + primaryFooter = "PrimaryFooter", /** - * Restart numbering at the beginning of each section. + * First page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartSection = "RestartSection", + firstPageFooter = "FirstPageFooter", /** - * Restart numbering at the beginning of each page. + * Even pages footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartPage = "RestartPage", - } - /** - * Specifies a page layout orientation. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageOrientation { + evenPagesFooter = "EvenPagesFooter", /** - * Portrait orientation. + * Footnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - portrait = "Portrait", + footnotes = "Footnotes", /** - * Landscape orientation. + * Endnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - landscape = "Landscape", + endnotes = "Endnotes", + /** + * Current page header. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + currentPageHeader = "CurrentPageHeader", + /** + * Current page footer. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + currentPageFooter = "CurrentPageFooter", } /** - * Specifies the type of vertical alignment to apply. + * Specifies the source documents to show. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PageSetupVerticalAlignment { + enum ShowSourceDocuments { /** - * Align text to the top. + * Specifies that no source documents are shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + none = "None", /** - * Align text to the center. + * Specifies that the original source document is shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + original = "Original", /** - * Justify text vertically. + * Specifies that the revised source document is shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justify = "Justify", + revised = "Revised", /** - * Align text to the bottom. + * Specifies that both the original and revised source documents are shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + both = "Both", } /** - * Specifies a paper size. + * Specifies the special pane options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PaperSize { + enum SpecialPane { /** - * 10x14 paper size. + * None. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size10x14 = "Size10x14", + none = "None", /** - * 11x17 paper size. + * Primary header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size11x17 = "Size11x17", + primaryHeader = "PrimaryHeader", /** - * Letter paper size. + * First page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letter = "Letter", + firstPageHeader = "FirstPageHeader", /** - * Small letter paper size. + * Even pages header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterSmall = "LetterSmall", + evenPagesHeader = "EvenPagesHeader", /** - * Legal paper size. + * Primary footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legal = "Legal", + primaryFooter = "PrimaryFooter", /** - * Executive paper size. + * First page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - executive = "Executive", + firstPageFooter = "FirstPageFooter", /** - * A3 paper size. + * Even pages footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a3 = "A3", + evenPagesFooter = "EvenPagesFooter", /** - * A4 paper size. + * Footnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a4 = "A4", + footnotes = "Footnotes", /** - * Small A4 paper size. + * Endnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a4Small = "A4Small", + endnotes = "Endnotes", /** - * A5 paper size. + * Footnote continuation notice. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a5 = "A5", + footnoteContinuationNotice = "FootnoteContinuationNotice", /** - * B4 paper size. + * Footnote continuation separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - b4 = "B4", + footnoteContinuationSeparator = "FootnoteContinuationSeparator", /** - * B5 paper size. + * Footnote separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - b5 = "B5", + footnoteSeparator = "FootnoteSeparator", /** - * C-sheet paper size. + * Endnote continuation notice. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - csheet = "CSheet", + endnoteContinuationNotice = "EndnoteContinuationNotice", /** - * D-sheet paper size. + * Endnote continuation separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dsheet = "DSheet", + endnoteContinuationSeparator = "EndnoteContinuationSeparator", /** - * E-sheet paper size. + * Endnote separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - esheet = "ESheet", + endnoteSeparator = "EndnoteSeparator", /** - * Fanfold legal German paper size. + * Comments. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldLegalGerman = "FanfoldLegalGerman", + comments = "Comments", /** - * Fanfold standard German paper size. + * Current page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldStdGerman = "FanfoldStdGerman", + currentPageHeader = "CurrentPageHeader", /** - * Fanfold US paper size. + * Current page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldUS = "FanfoldUS", + currentPageFooter = "CurrentPageFooter", /** - * Folio paper size. + * Revisions. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - folio = "Folio", + revisions = "Revisions", /** - * Ledger paper size. + * Revisions horizontal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ledger = "Ledger", + revisionsHoriz = "RevisionsHoriz", /** - * Note paper size. + * Revisions vertical. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - note = "Note", + revisionsVert = "RevisionsVert", + } + /** + * Specifies the save options. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SaveConfiguration { /** - * Quarto paper size. + * Specifies not to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - quarto = "Quarto", + doNotSaveChanges = "DoNotSaveChanges", /** - * Statement paper size. + * Specifies to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - statement = "Statement", + saveChanges = "SaveChanges", /** - * Tabloid paper size. + * Specifies to prompt to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabloid = "Tabloid", + promptToSaveChanges = "PromptToSaveChanges", + } + /** + * Specifies the page color options in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageColor { /** - * Envelope size 9. + * None. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope9 = "Envelope9", + none = "None", /** - * Envelope size 10. + * Sepia. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope10 = "Envelope10", + sepia = "Sepia", /** - * Envelope size 11. + * Inverse. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope11 = "Envelope11", + inverse = "Inverse", + } + /** + * Specifies the page movement type in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageMovementType { /** - * Envelope size 12. + * Vertical. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope12 = "Envelope12", + vertical = "Vertical", /** - * Envelope size 14. + * Side to side. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope14 = "Envelope14", + sideToSide = "SideToSide", + } + /** + * Specifies the margin options in reading layout view in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReadingLayoutMargin { /** - * Envelope B4 size. + * Microsoft Word determines automatically whether to show or hide the margins based on the available space. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB4 = "EnvelopeB4", + automatic = "Automatic", /** - * Envelope B5 size. + * Hides margins. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB5 = "EnvelopeB5", + suppress = "Suppress", /** - * Envelope B6 size. + * Shows margins. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB6 = "EnvelopeB6", + full = "Full", + } + /** + * Specifies the margin for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsBalloonMargin { /** - * Envelope C3 size. + * Left margin. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC3 = "EnvelopeC3", + left = "Left", /** - * Envelope C4 size. + * Right margin. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC4 = "EnvelopeC4", + right = "Right", + } + /** + * Specifies the width type for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsBalloonWidthType { /** - * Envelope C5 size. + * Balloon width as a percentage. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC5 = "EnvelopeC5", + percent = "Percent", /** - * Envelope C6 size. + * Balloon width in points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC6 = "EnvelopeC6", + points = "Points", + } + /** + * Specifies the extent of markup visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsMarkup { /** - * Envelope C65 size. + * No markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC65 = "EnvelopeC65", + none = "None", /** - * Envelope DL size. + * Simple markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeDL = "EnvelopeDL", + simple = "Simple", /** - * Envelope Italy size. + * All markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeItaly = "EnvelopeItaly", + all = "All", + } + /** + * Specifies the display mode for tracked changes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsMode { /** - * Envelope Monarch size. + * Balloon. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeMonarch = "EnvelopeMonarch", + balloon = "Balloon", /** - * Envelope Personal size. + * Inline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopePersonal = "EnvelopePersonal", + inline = "Inline", /** - * Custom paper size. + * Mixed. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "Custom", + mixed = "Mixed", } /** - * Specifies how Word displays the reading order and alignment for the specified sections. + * 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 */ - enum SectionDirection { + enum RevisionsView { /** - * Right-to-left reading order. + * Final view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + final = "Final", /** - * Left-to-right reading order. + * Original view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + original = "Original", } /** - * Specifies the type of section break for the specified item. + * Specifies the revision type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum SectionStart { + enum RevisionType { /** - * Continuous section break. + * No revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - continuous = "Continuous", + none = "None", /** - * New column section break. + * Insert revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newColumn = "NewColumn", + insert = "Insert", /** - * New page section break. + * Delete revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newPage = "NewPage", + delete = "Delete", /** - * Even page section break. + * Property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPage = "EvenPage", + property = "Property", /** - * Odd page section break. + * Paragraph number revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddPage = "OddPage", - } - enum ErrorCodes { - accessDenied = "AccessDenied", - generalException = "GeneralException", - invalidArgument = "InvalidArgument", - itemNotFound = "ItemNotFound", - notAllowed = "NotAllowed", - notImplemented = "NotImplemented", - searchDialogIsOpen = "SearchDialogIsOpen", - searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", + paragraphNumber = "ParagraphNumber", + /** + * Display field revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + displayField = "DisplayField", + /** + * Reconcile revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reconcile = "Reconcile", + /** + * Conflict revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + conflict = "Conflict", + /** + * Style revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + style = "Style", + /** + * Replace revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + replace = "Replace", + /** + * Paragraph property revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraphProperty = "ParagraphProperty", + /** + * Table property revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableProperty = "TableProperty", + /** + * Section property revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sectionProperty = "SectionProperty", + /** + * Style definition revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + styleDefinition = "StyleDefinition", + /** + * Moved from revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + movedFrom = "MovedFrom", + /** + * Moved to revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + movedTo = "MovedTo", + /** + * Cell insertion revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cellInsertion = "CellInsertion", + /** + * Cell deletion revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cellDeletion = "CellDeletion", + /** + * Cell merge revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cellMerge = "CellMerge", + /** + * Cell split revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cellSplit = "CellSplit", + /** + * Conflict insert revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + conflictInsert = "ConflictInsert", + /** + * Conflict delete revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + conflictDelete = "ConflictDelete", } - namespace Interfaces { + /** + * Specifies the column width options in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ColumnWidth { /** - * Provides ways to load properties of only a subset of members of a collection. + * Narrow column width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface CollectionLoadOptions { + narrow = "Narrow", + /** + * Default column width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + default = "Default", + /** + * Wide column width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wide = "Wide", + } + /** + * Specifies the field shading options in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FieldShading { + /** + * Never shade fields. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + never = "Never", + /** + * Always shade fields. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + always = "Always", + /** + * Shade fields when selected. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + whenSelected = "WhenSelected", + } + /** + * Specifies the format for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HorizontalInVerticalType { + /** + * No formatting is applied to the horizontal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * The horizontal text is sized to fit in the line of vertical text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fitInLine = "FitInLine", + /** + * The line of vertical text is sized to accommodate the horizontal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + resizeLine = "ResizeLine", + } + /** + * Specifies the IME (Input Method Editor) mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ImeMode { + /** + * Specifies no control over the IME mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noControl = "NoControl", + /** + * Specifies the IME mode is on. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + on = "On", + /** + * Specifies the IME mode is off. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + off = "Off", + /** + * Specifies the Hiragana IME mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hiragana = "Hiragana", + /** + * Specifies the Katakana (double-byte) IME mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + katakana = "Katakana", + /** + * Specifies the Katakana (half-width) IME mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + katakanaHalf = "KatakanaHalf", + /** + * Specifies the full-width alphanumeric IME mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + alphaFull = "AlphaFull", + /** + * Specifies the half-width alphanumeric IME mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + alpha = "Alpha", + /** + * Specifies the full-width Hangul IME mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hangulFull = "HangulFull", + /** + * Specifies the half-width Hangul IME mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hangul = "Hangul", + } + /** + * Specifies the Kana type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Kana { + /** + * Katakana Kana type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + katakana = "Katakana", + /** + * Hiragana Kana type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hiragana = "Hiragana", + } + /** + * Specifies the two lines in one type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TwoLinesInOneType { + /** + * No two lines in one. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Two lines in one without brackets. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noBrackets = "NoBrackets", + /** + * Two lines in one with parentheses. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parentheses = "Parentheses", + /** + * Two lines in one with square brackets. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + squareBrackets = "SquareBrackets", + /** + * Two lines in one with angle brackets. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + angleBrackets = "AngleBrackets", + /** + * Two lines in one with curly brackets. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + curlyBrackets = "CurlyBrackets", + } + /** + * Specifies the underline type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Underline { + /** + * No underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Single underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + single = "Single", + /** + * Underline words only. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + words = "Words", + /** + * Double underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + double = "Double", + /** + * Dotted underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dotted = "Dotted", + /** + * Thick underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thick = "Thick", + /** + * Dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dash = "Dash", + /** + * Dot dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dotDash = "DotDash", + /** + * Dot dot dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dotDotDash = "DotDotDash", + /** + * Wavy underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wavy = "Wavy", + /** + * Heavy wavy underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wavyHeavy = "WavyHeavy", + /** + * Heavy dotted underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dottedHeavy = "DottedHeavy", + /** + * Heavy dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashHeavy = "DashHeavy", + /** + * Heavy dot dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dotDashHeavy = "DotDashHeavy", + /** + * Heavy dot dot dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dotDotDashHeavy = "DotDotDashHeavy", + /** + * Long dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashLong = "DashLong", + /** + * Heavy long dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashLongHeavy = "DashLongHeavy", + /** + * 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", + } + /** + * Specifies the direction in which text flows from one text column to the next. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FlowDirection { + /** + * Text flows from left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + /** + * Text flows from right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + } + /** + * Specifies where the gutter appears in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GutterPosition { + /** + * The gutter appears on the left side of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * The gutter appears on the right side of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * The gutter appears at the top of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + } + /** + * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GutterStyle { + /** + * Gutter style for bidirectional text flow. This is mainly right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + /** + * Gutter style for Latin text flow. This is mainly left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + latin = "Latin", + } + /** + * Specifies how text is laid out in the layout mode for the current document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LayoutMode { + /** + * Default layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + default = "Default", + /** + * Grid layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid = "Grid", + /** + * Line grid layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineGrid = "LineGrid", + /** + * Genko layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + genko = "Genko", + } + /** + * Specifies the numbering rule to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberingRule { + /** + * Restart numbering continuously. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartContinuous = "RestartContinuous", + /** + * Restart numbering at the beginning of each section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartSection = "RestartSection", + /** + * Restart numbering at the beginning of each page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartPage = "RestartPage", + } + /** + * Specifies a page layout orientation. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageOrientation { + /** + * Portrait orientation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + portrait = "Portrait", + /** + * Landscape orientation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + landscape = "Landscape", + } + /** + * Specifies the type of vertical alignment to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageSetupVerticalAlignment { + /** + * Align text to the top. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + /** + * Align text to the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Justify text vertically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + justify = "Justify", + /** + * Align text to the bottom. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottom = "Bottom", + } + /** + * Specifies a paper size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PaperSize { + /** + * 10x14 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size10x14 = "Size10x14", + /** + * 11x17 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size11x17 = "Size11x17", + /** + * Letter paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letter = "Letter", + /** + * Small letter paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterSmall = "LetterSmall", + /** + * Legal paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legal = "Legal", + /** + * Executive paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + executive = "Executive", + /** + * A3 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a3 = "A3", + /** + * A4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a4 = "A4", + /** + * Small A4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a4Small = "A4Small", + /** + * A5 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a5 = "A5", + /** + * B4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + b4 = "B4", + /** + * B5 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + b5 = "B5", + /** + * C-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + csheet = "CSheet", + /** + * D-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dsheet = "DSheet", + /** + * E-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + esheet = "ESheet", + /** + * Fanfold legal German paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldLegalGerman = "FanfoldLegalGerman", + /** + * Fanfold standard German paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldStdGerman = "FanfoldStdGerman", + /** + * Fanfold US paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldUS = "FanfoldUS", + /** + * Folio paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + folio = "Folio", + /** + * Ledger paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ledger = "Ledger", + /** + * Note paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + note = "Note", + /** + * Quarto paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + quarto = "Quarto", + /** + * Statement paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + statement = "Statement", + /** + * Tabloid paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabloid = "Tabloid", + /** + * Envelope size 9. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope9 = "Envelope9", + /** + * Envelope size 10. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope10 = "Envelope10", + /** + * Envelope size 11. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope11 = "Envelope11", + /** + * Envelope size 12. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope12 = "Envelope12", + /** + * Envelope size 14. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope14 = "Envelope14", + /** + * Envelope B4 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB4 = "EnvelopeB4", + /** + * Envelope B5 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB5 = "EnvelopeB5", + /** + * Envelope B6 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB6 = "EnvelopeB6", + /** + * Envelope C3 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC3 = "EnvelopeC3", + /** + * Envelope C4 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC4 = "EnvelopeC4", + /** + * Envelope C5 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC5 = "EnvelopeC5", + /** + * Envelope C6 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC6 = "EnvelopeC6", + /** + * Envelope C65 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC65 = "EnvelopeC65", + /** + * Envelope DL size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeDL = "EnvelopeDL", + /** + * Envelope Italy size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeItaly = "EnvelopeItaly", + /** + * Envelope Monarch size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeMonarch = "EnvelopeMonarch", + /** + * Envelope Personal size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopePersonal = "EnvelopePersonal", + /** + * Custom paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + custom = "Custom", + } + /** + * Specifies how Word displays the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SectionDirection { + /** + * Right-to-left reading order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + /** + * Left-to-right reading order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the type of section break for the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SectionStart { + /** + * Continuous section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + continuous = "Continuous", + /** + * New column section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newColumn = "NewColumn", + /** + * New page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newPage = "NewPage", + /** + * Even page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPage = "EvenPage", + /** + * Odd page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddPage = "OddPage", + } + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Specifies the ending character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end: number; + /** + * Returns `true` if the bookmark is a table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isColumn: boolean; + /** + * Returns `true` if the bookmark is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEmpty: boolean; + /** + * Returns the name of the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Specifies the starting character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start: number; + /** + * Returns the story type for the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name The name of the new bookmark. + */ + copyTo(name: string): Word.Bookmark; + /** + * Deletes the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * Selects the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @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; + /** + * Gets a `Bookmark` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `Bookmark` object. + */ + getItem(index: number): Word.Bookmark; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum StoryType { + /** + * Main text story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mainText = "MainText", + /** + * Footnotes story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnotes = "Footnotes", + /** + * Endnotes story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnotes = "Endnotes", + /** + * Comments story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comments = "Comments", + /** + * Text frame story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textFrame = "TextFrame", + /** + * Even pages header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesHeader = "EvenPagesHeader", + /** + * Primary header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryHeader = "PrimaryHeader", + /** + * Even pages footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesFooter = "EvenPagesFooter", + /** + * Primary footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryFooter = "PrimaryFooter", + /** + * First page header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageHeader = "FirstPageHeader", + /** + * First page footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageFooter = "FirstPageFooter", + /** + * Footnote separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteSeparator = "FootnoteSeparator", + /** + * Footnote continuation separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteContinuationSeparator = "FootnoteContinuationSeparator", + /** + * Footnote continuation notice story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteContinuationNotice = "FootnoteContinuationNotice", + /** + * Endnote separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteSeparator = "EndnoteSeparator", + /** + * Endnote continuation separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteContinuationSeparator = "EndnoteContinuationSeparator", + /** + * Endnote continuation notice story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + readonly numberOfColumns: number; + /** + * Specifies if page numbers are aligned with the right margin in the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly separateAccentedLetterHeadings: boolean; + /** + * Specifies the sorting criteria for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + /** + * Gets the index type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFormat(): OfficeExtension.ClientResult; + /** + * Gets an `Index` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of an `Index` object. + */ + getItem(index: number): Word.Index; + /** + * 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 + * + * @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: 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 `Word.HeadingSeparator.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 `Word.IndexSortBy.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 `Word.IndexType.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 + */ + 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 + */ + 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 + */ + 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 + */ + 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 + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + italic?: boolean; + } + /** + * Represents options for marking an index entry in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface IndexMarkEntryOptions { + /** + * 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 + */ + 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 + */ + 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 + */ + 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 + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + enum HeadingSeparator { + /** + * No separator is used for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * A blank line is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + blankLine = "BlankLine", + /** + * A single letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letter = "Letter", + /** + * A lowercase letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterLow = "LetterLow", + /** + * A full-width letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterFull = "LetterFull", + } + /** + * Represents the position of a dropped capital letter. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DropPosition { + /** + * Represents that there's no dropped capital letter. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents a normal dropped capital letter. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + normal = "Normal", + /** + * Represents a dropped capital letter in the margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + enum TabAlignment { + /** + * Represents that the tab stop is aligned to the left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * Represents that the tab stop is aligned to the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Represents that the tab stop is aligned to the right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * Represents that the tab stop is aligned to the decimal point. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + decimal = "Decimal", + /** + * Represents that the tab stop is aligned to the bar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bar = "Bar", + /** + * Represents that the tab stop is aligned to the list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + enum IndexFilter { + /** + * No filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Aiueo filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + aiueo = "Aiueo", + /** + * Akasatana filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + akasatana = "Akasatana", + /** + * Chosung filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chosung = "Chosung", + /** + * Low filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + low = "Low", + /** + * Medium filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + medium = "Medium", + /** + * Full filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + full = "Full", + } + /** + * Specifies the format for an index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexFormat { + /** + * Template format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + template = "Template", + /** + * Classic format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic = "Classic", + /** + * Fancy format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fancy = "Fancy", + /** + * Modern format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + modern = "Modern", + /** + * Bulleted format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bulleted = "Bulleted", + /** + * Formal format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formal = "Formal", + /** + * Simple format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple = "Simple", + } + /** + * Specifies how an index is sorted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexSortBy { + /** + * Sort by stroke. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stroke = "Stroke", + /** + * Sort by syllable. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + syllable = "Syllable", + } + /** + * Specifies the type of index to create. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexType { + /** + * Creates an indented index. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indent = "Indent", + /** + * Creates a run-in index. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + runin = "Runin", + } + /** + * Specifies the tab leader style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TabLeader { + /** + * Spaces are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spaces = "Spaces", + /** + * Dots are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dots = "Dots", + /** + * Dashes are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashes = "Dashes", + /** + * Lines are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lines = "Lines", + /** + * Heavy lines are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heavy = "Heavy", + /** + * Middle dots are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + middleDot = "MiddleDot", + } + 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 `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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * Specifies if Microsoft Word automatically detects the language you are using as you type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + artWidth?: number; + /** + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: string; + /** + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * Specifies the line style of the border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + description?: string; + /** + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + /** + * Specifies the name of the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * Specifies the contents of the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 `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 `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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ + interface CustomXmlValidationErrorCollectionUpdateData { + items?: Word.Interfaces.CustomXmlValidationErrorData[]; + } + /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ + interface CustomXmlValidationErrorUpdateData { + /** + * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + node?: Word.Interfaces.CustomXmlNodeUpdateData; + } + /** 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Specifies the value of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeValue?: string; + /** + * Specifies the text for the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 is 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesUpdateData; + /** + * Specifies if automatic hyphenation is turned on for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoHyphenation?: boolean; + /** + * Specifies if the edits in the document are automatically saved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + consecutiveHyphensLimit?: number; + /** + * Specifies whether words in all capital letters can be hyphenated. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyphenateCaps?: boolean; + /** + * Specifies whether Microsoft Word has detected the language of the document text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected?: boolean; + } + /** 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 an "Addin" field. If the field isn't an "Addin" field, it is `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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + glow?: Word.Interfaces.GlowFormatUpdateData; + /** + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line?: Word.Interfaces.LineFormatUpdateData; + /** + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reflection?: Word.Interfaces.ReflectionFormatUpdateData; + /** + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textShadow?: Word.Interfaces.ShadowFormatUpdateData; + /** + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + allCaps?: boolean; + /** + * Specifies a value that indicates 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + boldBidirectional?: boolean; + /** + * Specifies the color for the specified 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + diacriticColor?: string; + /** + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + disableCharacterSpaceGrid?: boolean; + /** + * Specifies a value that indicates 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emboss?: boolean; + /** + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + engrave?: boolean; + /** + * Specifies a value that indicates 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 a value that indicates 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italicBidirectional?: boolean; + /** + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kerning?: number; + /** + * Specifies the ligature setting for the `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + /** + * Specifies a value that represents 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameAscii?: string; + /** + * Specifies the font name in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameBidirectional?: string; + /** + * Specifies the East Asian font name. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameFarEast?: string; + /** + * Specifies the font used for characters with codes from 128 through 255. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameOther?: string; + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + /** + * Specifies the number spacing setting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outline?: boolean; + /** + * Specifies the position of text (in points) relative to the base line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position?: number; + /** + * Specifies the scaling percentage applied to the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shadow?: boolean; + /** + * Specifies a value that represents 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + smallCaps?: boolean; + /** + * Specifies the spacing between characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spacing?: number; + /** + * Specifies a value that indicates 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 a value that indicates 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 a value that indicates 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 a value that indicates 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the address (for example, a file name or URL) of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + address?: string; + /** + * Specifies the text string for the hyperlink's subject line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emailSubject?: string; + /** + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + screenTip?: string; + /** + * Specifies a named location in the destination of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subAddress?: string; + /** + * Specifies the name of the frame or window in which to load the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + target?: string; + /** + * Specifies the hyperlink's visible text in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAutoUpdated?: boolean; + /** + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLocked?: boolean; + /** + * Specifies if the linked picture is saved with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 specified 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 specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + linkedStyle?: string; + /** + * Specifies the number format for the specified list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberFormat?: string; + /** + * Specifies the position (in points) of the number or bullet for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberPosition?: number; + /** + * Specifies the number style for the list level 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 the specified list level restarts numbering at 1. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + resetOnHigher?: number; + /** + * Specifies the starting number for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + startAt?: number; + /** + * Specifies the tab position for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + tabPosition?: number; + /** + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + textPosition?: number; + /** + * Specifies the character inserted after the number for the specified 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 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classType?: string; + /** + * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconIndex?: number; + /** + * Specifies the text displayed below the icon for the OLE object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconLabel?: string; + /** + * Specifies the program file in which the icon for the OLE object is stored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconName?: string; + /** + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + next?: Word.Interfaces.WindowUpdateData; + /** + * Gets the previous document window in the collection open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previous?: Word.Interfaces.WindowUpdateData; + /** + * Specifies whether rulers are displayed for the window or pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + caption?: string; + /** + * Specifies the horizontal scroll position as a percentage of the document width. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalPercentScrolled?: number; + /** + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + isEnvelopeVisible?: boolean; + /** + * Specifies whether a horizontal scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + isRightRulerDisplayed?: boolean; + /** + * Specifies whether the window is split into multiple panes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isSplit?: boolean; + /** + * Specifies whether a vertical ruler is displayed for the window or pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVerticalRulerDisplayed?: boolean; + /** + * Specifies whether a vertical scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVerticalScrollBarDisplayed?: boolean; + /** + * Specifies whether the window is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * Specifies how Microsoft Word displays source documents after a compare and merge process. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + /** + * Specifies the vertical split percentage for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + splitVertical?: number; + /** + * Specifies the width of the style area in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + styleAreaWidth?: number; + /** + * Specifies the vertical scroll position as a percentage of the document length. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalPercentScrolled?: 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 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listFormat?: Word.Interfaces.ListFormatUpdateData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies a `CharacterCase` value that represents the case of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + characterWidth?: Word.CharacterWidth | "Half" | "Full"; + /** + * Specifies if the range contains combined characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + combineCharacters?: boolean; + /** + * Specifies the ending character position of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + fitTextWidth?: number; + /** + * Specifies if a grammar check has been run on the range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grammarChecked?: boolean; + /** + * Specifies the proofing status (spelling and grammar checking) of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hasNoProofing?: boolean; + /** + * Specifies the formatting for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: string; + /** + * Specifies whether the range of Japanese language text is hiragana or katakana. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kana?: Word.Kana | "Katakana" | "Hiragana"; + /** + * Specifies whether Microsoft Word has detected the language of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected?: boolean; + /** + * Specifies a `LanguageId` value that represents the language for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showAll?: boolean; + /** + * Specifies if spelling has been checked throughout the range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spellingChecked?: boolean; + /** + * Specifies the starting character position of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 { + /** + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignorePunct?: boolean; + /** + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignoreSpace?: boolean; + /** + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchCase?: boolean; + /** + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchPrefix?: boolean; + /** + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchSuffix?: boolean; + /** + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWholeWord?: boolean; + /** + * Specifies a value that indicates whether the search will be performed using special search operators. 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** + * Specifies if the section is protected for forms. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 specified style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + borders?: Word.Interfaces.BorderCollectionUpdateData; + /** + * Gets a font object that represents the character formatting of the specified 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + frame?: Word.Interfaces.FrameUpdateData; + /** + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + linkStyle?: Word.Interfaces.StyleUpdateData; + /** + * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + listTemplate?: Word.Interfaces.ListTemplateUpdateData; + /** + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; + /** + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * + * @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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hasProofing?: boolean; + /** + * Specifies a `LanguageId` value that represents the language for the style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 specified 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 specified style is made visible as a recommended style in the Styles 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 specified 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + backgroundPatternColor?: string; + /** + * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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; /** - * Specify the number of items in the queried collection to be included in the result. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * + * @remarks + * [Api set: WordApi 1.3] */ - $top?: number; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * 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. + * Specifies the number of header rows. + * + * @remarks + * [Api set: WordApi 1.3] */ - $skip?: number; + 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 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 `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ - interface AnnotationCollectionUpdateData { - items?: Word.Interfaces.AnnotationData[]; + /** 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 specified 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 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 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 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 `Application` object, for use in `application.set({ ... })`. */ - interface ApplicationUpdateData { + /** 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 `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyUpdateData; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkLanguage?: boolean; + preferredWidth?: number; + /** + * Specifies the preferred unit of measurement to use for the width of the table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + /** + * Specifies the width of the column, in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; } - /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ - interface BodyUpdateData { + /** 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 { /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ 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. + * 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] */ - style?: string; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * 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 preferred height of the row in points. * * @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"; + 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 `Border` object, for use in `border.set({ ... })`. */ - interface BorderUpdateData { + /** 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 { /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [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 border type for the border. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [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 whether the border is visible. + * 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] */ - visible?: boolean; + width?: number; + } + /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ + interface TemplateUpdateData { /** - * Specifies the width for the border. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Specifies the graphical page-border design for the document. + * Specifies the line break control level for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: number; + hasNoProofing?: boolean; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the character spacing adjustment for the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + kerningByAlgorithm?: boolean; /** - * Specifies whether the border is visible. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + 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 line style of the border. + * Specifies an East Asian language for the language in the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + 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 line width of an object's border. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + noLineBreakAfter?: string; + /** + * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + saved?: boolean; } - /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ - interface BorderCollectionUpdateData { + /** 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 the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areBackgroundsDisplayed?: boolean; + /** + * Specifies whether Microsoft Word displays the comments in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + areEditableRangesShaded?: boolean; + /** + * Specifies whether field codes are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areFormatChangesDisplayed?: boolean; + /** + * Specifies whether handwritten ink annotations are shown or hidden. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areInsertionsAndDeletionsDisplayed?: boolean; + /** + * Gets whether other authors' presence should be visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areRevisionsAndCommentsDisplayed?: boolean; + /** + * Specifies whether table gridlines are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areTableGridlinesDisplayed?: boolean; + /** + * Specifies the column width in Reading mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + isDraft?: boolean; + /** + * Specifies whether only the first line of body text is shown in outline view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFirstLineOnlyDisplayed?: boolean; + /** + * Specifies whether character formatting is visible in outline view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFormatDisplayed?: boolean; + /** + * Specifies whether the window is in full-screen view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFullScreen?: boolean; + /** + * Specifies whether the document is in conflict mode view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isInConflictMode?: boolean; + /** + * Specifies whether Microsoft Word is in Panning mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isInPanning?: boolean; + /** + * Specifies whether the document is being viewed in reading layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isInReadingLayout?: boolean; + /** + * Specifies whether mail merge data is displayed instead of mail merge fields. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + isMainTextLayerVisible?: boolean; + /** + * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 */ - insideBorderColor?: string; + isReadingLayoutActualView?: boolean; /** - * Specifies the border type of the inside borders. + * Specifies whether XML tags are visible in the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + isXmlMarkupVisible?: boolean; /** - * Specifies the width of the inside borders. + * Specifies the display mode for tracked changes. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outsideBorderColor?: string; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Specifies the border type of the outside borders. + * Specifies the page movement type. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies the width of the outside borders. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + revisionsBalloonWidth?: number; /** - * Specifies the description for the building block. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Specifies the name of the building block. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: 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 the contents of the building block. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: string; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; } - /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ - interface CheckboxContentControlUpdateData { + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + interface ShapeUpdateData { /** - * Specifies the current state of the checkbox. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.2] */ - isChecked?: boolean; - } - /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ - interface CommentUpdateData { + body?: Word.Interfaces.BodyUpdateData; /** - * Specifies the comment's content range. + * 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.4] + * [Api set: WordApiDesktop 1.2] */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + canvas?: Word.Interfaces.CanvasUpdateData; /** - * Specifies the comment's content as plain text. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - content?: string; + fill?: Word.Interfaces.ShapeFillUpdateData; /** - * 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 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.4] + * [Api set: WordApiDesktop 1.2] */ - 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 { + parentCanvas?: Word.Interfaces.ShapeUpdateData; /** - * Specifies a value that indicates whether the comment text is bold. + * 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.4] + * [Api set: WordApiDesktop 1.2] */ - bold?: boolean; + parentGroup?: Word.Interfaces.ShapeUpdateData; /** - * 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. + * 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.4] + * [Api set: WordApiDesktop 1.2] */ - hyperlink?: string; + shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; /** - * Specifies a value that indicates whether the comment text is italicized. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - italic?: boolean; + textFrame?: Word.Interfaces.TextFrameUpdateData; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - strikeThrough?: boolean; + textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - 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 { + allowOverlap?: boolean; /** - * Specifies the commentReply's content range. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + altTextDescription?: string; /** - * Gets the parent comment of this reply. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - parentComment?: Word.Interfaces.CommentUpdateData; + 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"; /** - * Specifies the comment reply's content. The string is plain text. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - 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 `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ - interface XmlMappingUpdateData { + height?: number; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + heightRelative?: number; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - 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 `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ - interface CustomXmlValidationErrorCollectionUpdateData { - items?: Word.Interfaces.CustomXmlValidationErrorData[]; - } - /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ - interface CustomXmlValidationErrorUpdateData { + left?: number; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - node?: Word.Interfaces.CustomXmlNodeUpdateData; - } - /** 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 { + leftRelative?: 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`. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + lockAspectRatio?: 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`. + * The name of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + name?: string; /** - * 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`. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the object representing the part associated with this node. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * 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`. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the value of the current node. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - nodeValue?: string; + rotation?: number; /** - * Specifies the text for the current node. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - text?: string; - } - /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ - interface ContentControlUpdateData { + top?: number; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; + topRelative?: number; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.2] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; + visible?: boolean; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; + width?: number; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontUpdateData; + widthRelative?: number; + } + /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ + interface ShapeGroupUpdateData { /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + shape?: Word.Interfaces.ShapeUpdateData; + } + /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ + interface CanvasUpdateData { /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + 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 { /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + backgroundColor?: string; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + foregroundColor?: string; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + transparency?: number; + } + /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ + interface TextFrameUpdateData { /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - cannotDelete?: boolean; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - cannotEdit?: boolean; + bottomMargin?: number; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - color?: string; + leftMargin?: number; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - placeholderText?: string; + noTextRotation?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - removeWhenEdited?: boolean; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * 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. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - style?: string; + rightMargin?: 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. + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - 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"; + topMargin?: number; /** - * Specifies a tag to identify a content control. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - tag?: string; + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Specifies the title for a content control. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - title?: string; - } - /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ - interface ContentControlCollectionUpdateData { - items?: Word.Interfaces.ContentControlData[]; + wordWrap?: boolean; } - /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ - interface ContentControlListItemUpdateData { + /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ + interface ShapeTextWrapUpdateData { /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * 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.9] + * [Api set: WordApiDesktop 1.2] */ - displayText?: string; + bottomDistance?: number; /** - * Specifies the index location of a content control list item in the collection of list items. + * 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.9] + * [Api set: WordApiDesktop 1.2] */ - index?: number; + leftDistance?: number; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * 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.9] + * [Api set: WordApiDesktop 1.2] */ - 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 { + rightDistance?: number; /** - * 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). + * 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] */ - value?: any; - } - /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ - interface CustomPropertyCollectionUpdateData { - items?: Word.Interfaces.CustomPropertyData[]; + 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 `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ - interface CustomXmlPartUpdateData { + /** An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`. */ + interface ReviewerUpdateData { /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; - } - /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ - interface CustomXmlPartCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; + isVisible?: boolean; } - /** 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 `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`. */ + interface ReviewerCollectionUpdateData { + items?: Word.Interfaces.ReviewerData[]; } - /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ - interface DocumentUpdateData { + /** An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`. */ + interface RevisionsFilterUpdateData { /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyUpdateData; + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ + interface RepeatingSectionItemUpdateData { /** - * Returns a `PageSetup` object that's associated with the document. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ + interface DatePickerContentControlUpdateData { /** - * Gets the properties of the document. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies if automatic hyphenation is turned on for the document. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies if the edits in the document are automatically saved. + * 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 BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the ChangeTracking mode. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * 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 BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: number; + color?: string; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies the format in which dates are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; - } - /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ - interface DocumentCreatedUpdateData { + dateDisplayFormat?: string; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + 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"; /** - * Gets the properties of the document. + * 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: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; - } - /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ - interface DocumentPropertiesUpdateData { + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Specifies the author of the document. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: string; + isTemporary?: boolean; /** - * Specifies the category of the document. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - category?: string; + lockContentControl?: boolean; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comments?: string; + lockContents?: boolean; /** - * Specifies the company of the document. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - company?: string; + tag?: string; /** - * Specifies the format of the document. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - format?: string; + title?: string; + } + /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ + interface PictureContentControlUpdateData { /** - * Specifies the keywords of the document. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keywords?: string; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the manager of the document. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - manager?: string; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the subject of the document. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subject?: string; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the title of the document. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: string; - } - /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ - interface FieldUpdateData { + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets the field's result data. + * 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.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - result?: Word.Interfaces.RangeUpdateData; + color?: string; /** - * Specifies the field's code instruction. + * 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.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - code?: string; + isTemporary?: boolean; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - data?: string; + lockContentControl?: boolean; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - locked?: boolean; + lockContents?: boolean; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - glow?: Word.Interfaces.GlowFormatUpdateData; - /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - line?: Word.Interfaces.LineFormatUpdateData; - /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - reflection?: Word.Interfaces.ReflectionFormatUpdateData; - /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textColor?: Word.Interfaces.ColorFormatUpdateData; - /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textShadow?: Word.Interfaces.ShadowFormatUpdateData; - /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; + tag?: string; /** - * 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 title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allCaps?: boolean; + title?: string; + } + /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ + interface GroupContentControlUpdateData { /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * 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 a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * 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.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the color for the `Font` object in a right-to-left language 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + color?: string; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates?: boolean; + isTemporary?: boolean; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * 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 BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: string; + lockContentControl?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * 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 BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + lockContents?: boolean; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - doubleStrikeThrough?: boolean; + tag?: 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 title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss?: boolean; + title?: string; + } + /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ + interface BuildingBlockGalleryContentControlUpdateData { /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * 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. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - engrave?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * 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.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * 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. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - highlightColor?: string; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies the category for the building block content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + buildingBlockCategory?: string; /** - * 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 a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + 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 minimum font size for which Microsoft Word will adjust kerning automatically. + * 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 BETA (PREVIEW ONLY)] * @beta */ - kerning?: number; + color?: string; /** - * Specifies the ligature setting for the `Font` object. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + isTemporary?: boolean; /** - * Specifies a value that represents the name of the font. + * 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.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + lockContentControl?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * 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 BETA (PREVIEW ONLY)] * @beta */ - nameAscii?: string; + lockContents?: boolean; /** - * Specifies the font name in a right-to-left language document. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameBidirectional?: string; + tag?: string; /** - * Specifies the East Asian font name. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameFarEast?: string; + title?: string; + } + /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ + interface RepeatingSectionContentControlUpdateData { /** - * Specifies the font used for characters with codes from 128 through 255. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameOther?: string; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the number form setting for an OpenType font. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the number spacing setting for the font. + * 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 BETA (PREVIEW ONLY)] * @beta */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + xmlapping?: Word.Interfaces.XmlMappingUpdateData; /** - * 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 whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline?: boolean; + allowInsertDeleteSection?: boolean; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the scaling percentage applied to the font. + * 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 BETA (PREVIEW ONLY)] * @beta */ - scaling?: number; + color?: string; /** - * 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. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shadow?: boolean; + isTemporary?: boolean; /** - * Specifies a value that represents the font size 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.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - size?: number; + lockContentControl?: boolean; /** - * Specifies the font size in points for right-to-left 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - sizeBidirectional?: number; + lockContents?: 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 the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + repeatingSectionItemTitle?: string; /** - * Specifies the spacing between characters. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + tag?: string; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + title?: string; + } + /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ + interface FrameUpdateData { /** - * Specifies the stylistic set for the font. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subscript?: boolean; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies the height (in points) of the frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - superscript?: boolean; + height?: number; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underlineColor?: string; - } - /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ - interface HyperlinkUpdateData { + horizontalDistanceFromText?: number; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + horizontalPosition?: number; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies if the frame is locked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: string; + lockAnchor?: boolean; /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: string; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screenTip?: string; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies if document text wraps around the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subAddress?: string; + textWrap?: boolean; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - target?: string; + verticalDistanceFromText?: number; /** - * Specifies the hyperlink's visible text in the document. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + verticalPosition?: number; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies the width (in points) of the frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + width?: number; /** - * Specifies a string that contains the title for the inline image. + * Specifies the rule used to determine the width of the frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: string; + 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 { /** - * Specifies a number that describes the height of the inline image. + * Gets the list template associated with the `ListFormat` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + listLevelNumber?: number; + } + /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ + interface FillFormatUpdateData { /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies a number that describes the width of the inline image. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the level of the item in the list. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level?: number; - } - /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ - interface ListLevelUpdateData { + gradientAngle?: number; /** - * Gets a Font object that represents the character formatting of the specified object. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + isVisible?: boolean; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether the fill rotates with the shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + rotateWithObject?: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: string; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies the number format for the specified list level. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: string; + textureHorizontalScale?: number; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: number; + textureOffsetX?: number; /** - * Specifies the number style for the list level object. + * Specifies the vertical offset of the texture. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + textureOffsetY?: number; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies whether the texture is tiled. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: number; + textureTile?: boolean; /** - * Specifies the starting number for the specified list level object. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: number; + textureVerticalScale?: number; /** - * Specifies the tab position for the specified list level object. + * 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.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: number; + transparency?: number; + } + /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ + interface GlowFormatUpdateData { /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: number; + color?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the length of the radius for a glow effect. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + radius?: number; /** - * Specifies whether the specified ListTemplate object is outline numbered. + * 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.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineNumbered?: boolean; + transparency?: number; } - /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ - interface NoteItemUpdateData { + /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ + interface LineFormatUpdateData { /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Represents a footnote or endnote reference in the main document. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItem?: Word.Interfaces.ListItemUpdateData; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * 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}. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the length of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * 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 style of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies the width of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies if to draw lines inside a shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + insetPen?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + isVisible?: boolean; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies the pattern applied to the line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: 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 the outline level for the paragraph. + * Specifies the line format style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: number; + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + transparency?: number; /** - * Specifies the spacing, in points, after the paragraph. + * Specifies the thickness of the line in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + weight?: number; + } + /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ + interface ReflectionFormatUpdateData { /** - * Specifies the spacing, in points, before the paragraph. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + blur?: 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. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + offset?: 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 size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + size?: number; /** - * Specifies the alignment for the specified paragraphs. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + transparency?: number; /** - * 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 `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + 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 whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + brightness?: number; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies the theme color for a color format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Specifies the left indent. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + rgb?: string; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * 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: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + tintAndShade?: number; + } + /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ + interface ShadowFormatUpdateData { /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + blur?: number; /** - * Specifies whether left and right indents are the same width. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + isVisible?: boolean; /** - * Specifies the outline level for the specified paragraphs. + * 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: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + obscured?: boolean; /** - * Specifies the right indent (in points) for the specified paragraphs. + * 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: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + 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: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + offsetY?: number; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + rotateWithShape?: 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. + * Specifies the width of the shadow. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widowControl?: boolean; - } - /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ - interface RangeUpdateData { + size?: number; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; - /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - listFormat?: Word.Interfaces.ListFormatUpdateData; + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + transparency?: number; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + 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 { /** - * 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. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + contourColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + extrusionColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Specifies the depth of the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + bevelBottomDepth?: number; /** - * Specifies an East Asian language for the range. + * Specifies the inset size for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + bevelBottomInset?: number; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * 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 depth of the top bevel. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + bevelTopDepth?: number; /** - * 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 inset size for the top bevel. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + bevelTopInset?: number; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignorePunct?: boolean; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Specifies the width of the contour of a shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace?: boolean; + contourWidth?: number; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Specifies the depth of the shape's extrusion. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchCase?: boolean; + depth?: number; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * 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: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchPrefix?: boolean; + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Specifies the amount of perspective for a shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchSuffix?: boolean; + fieldOfView?: number; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * 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: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWholeWord?: boolean; + isPerspective?: boolean; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWildcards?: boolean; - } - /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ - interface SectionUpdateData { + isVisible?: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies the angle of the lighting. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + lightAngle?: number; /** - * Returns a `PageSetup` object that's associated with the section. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + 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 if the section is protected for forms. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies the value of the setting. + * Specifies the intensity of the extrusion lighting. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Specifies the extrusion surface material. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borders?: Word.Interfaces.BorderCollectionUpdateData; + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Gets a font object that represents the character formatting of the specified style. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + projectText?: boolean; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame?: Word.Interfaces.FrameUpdateData; + rotationX?: number; /** - * Specifies a link between a paragraph and a character style. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkStyle?: Word.Interfaces.StyleUpdateData; + rotationY?: number; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Specifies the z-axis rotation of the camera. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + rotationZ?: number; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Specifies the position on the z-axis for the shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; + z?: number; + } + /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ + interface BibliographyUpdateData { /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies the name of the active style to use for the bibliography. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shading?: Word.Interfaces.ShadingUpdateData; + 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 { /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleUpdateData; + lineNumbering?: Word.Interfaces.LineNumberingUpdateData; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; + bookFoldPrinting?: boolean; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies the number of pages for each booklet. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle?: string; + bookFoldPrintingSheets?: number; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing?: boolean; + bookFoldReversePrinting?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + bottomMargin?: number; /** - * Specifies an East Asian language for the style. + * Specifies the number of characters per line in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + charsLine?: number; /** - * Specifies whether the style cannot be changed or edited. + * Specifies whether the first page has a different header and footer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locked?: boolean; + differentFirstPageHeaderFooter?: boolean; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nextParagraphStyle?: string; + footerDistance?: number; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + gutter?: number; /** - * Specifies the priority. + * Specifies on which side the gutter appears in a document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - priority?: number; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies whether the style corresponds to an available quick style. + * 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.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - quickStyle?: boolean; + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Specifies the distance between the header and the top of the page in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed?: boolean; + headerDistance?: number; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies the layout mode for the current document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visibility?: boolean; - } - /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ - interface ShadingUpdateData { + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * 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.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundPatternColor?: string; + leftMargin?: number; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the number of lines per page in the document grid. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundPatternColor?: string; + linesPage?: number; /** - * 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 if the inside and outside margins of facing pages are the same width. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + mirrorMargins?: boolean; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColor?: string; + oddAndEvenPagesHeaderFooter?: boolean; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * 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 page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColor?: string; + pageHeight?: number; /** - * 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. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + pageWidth?: number; /** - * 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 the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + 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 font. Use this to get and set font name, size, color, and other properties. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + rightMargin?: number; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the reading order and alignment for the specified sections. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies the number of header rows. + * Specifies the type of section break for the specified object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: number; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies whether to show the grid. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + showGrid?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + suppressEndnotes?: 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 the top margin of the page in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + topMargin?: number; /** - * Specifies whether the table has banded columns. + * Specifies whether to print two pages per sheet. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + twoPagesOnOne?: boolean; /** - * Specifies whether the table has banded rows. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + 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 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 numeric increment for line numbers. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + countBy?: number; /** - * Specifies whether the table has a first column with a special style. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + distanceFromText?: number; /** - * Specifies whether the table has a last column with a special style. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleLastColumn?: boolean; + isActive?: boolean; /** - * Specifies whether the table has a total (last) row with a special style. + * 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: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Specifies the starting line number. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + 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 vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + spaceAfter?: number; /** - * Specifies the width of the table in points. + * Specifies the width, in points, of the specified text columns. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ width?: number; } - /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ - interface TableStyleUpdateData { + /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ + interface BookmarkUpdateData { /** - * Specifies the table's alignment against the page margin. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies the ending character position of the bookmark. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + end?: number; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies the starting character position of the bookmark. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: number; + 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 { /** - * Specifies the spacing (in points) between the cells in a table style. + * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: number; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: number; + 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 describing the data returned by calling `critiqueAnnotation.toJSON()`. */ + interface CritiqueAnnotationData { /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.7] */ - rightCellMargin?: number; + critique?: Word.Critique; + } + /** An interface describing the data returned by calling `annotation.toJSON()`. */ + interface AnnotationData { /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.7] */ - topCellMargin?: number; + id?: string; + /** + * Gets the state of the annotation. + * + * @remarks + * [Api set: WordApi 1.7] + */ + state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; } - /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ - interface TableCollectionUpdateData { - items?: Word.Interfaces.TableData[]; + /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ + interface AnnotationCollectionData { + items?: Word.Interfaces.AnnotationData[]; } - /** 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** An interface describing the data returned by calling `application.toJSON()`. */ + interface ApplicationData { /** - * 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. + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: number; + bibliography?: Word.Interfaces.BibliographyData; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + checkLanguage?: boolean; /** - * Specifies the width of the column, in points. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ - interface TableColumnCollectionUpdateData { - items?: Word.Interfaces.TableColumnData[]; + 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 for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ - interface TableRowUpdateData { + /** An interface describing the data returned by calling `body.toJSON()`. */ + interface BodyData { /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Gets the collection of rich text content control objects in the body. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - font?: Word.Interfaces.FontUpdateData; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Gets the collection of field objects in the body. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the preferred height of the row in points. + * 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.3] + * [Api set: WordApi 1.1] */ - preferredHeight?: number; + font?: Word.Interfaces.FontData; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - shadingColor?: string; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Gets the collection of list objects in the body. * * @remarks * [Api set: WordApi 1.3] */ - values?: string[][]; + lists?: Word.Interfaces.ListData[]; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Gets the collection of paragraph objects in the body. * * @remarks - * [Api set: WordApi 1.3] + * [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. */ - 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 { + paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the body object of the cell. + * 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: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyUpdateData; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Gets the collection of table objects in the body. * * @remarks * [Api set: WordApi 1.3] */ - columnWidth?: number; + tables?: Word.Interfaces.TableData[]; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + style?: string; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * 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] */ - shadingColor?: 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 text of the cell. + * Gets the text of the body. Use the insertText method to insert text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - value?: string; + text?: string; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * 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 WordApiOnline 1.1 and later. * * @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[]; + type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; } - /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ - interface TableBorderUpdateData { + /** An interface describing the data returned by calling `border.toJSON()`. */ + interface BorderData { /** - * Specifies the table border color. + * 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: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - color?: string; + location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; /** - * Specifies the type of the table border. + * Specifies the border type for the border. * * @remarks - * [Api set: WordApi 1.3] + * [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 the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - width?: number; + 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 `Template` object, for use in `template.set({ ... })`. */ - interface TemplateUpdateData { + /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ + interface BorderUniversalData { /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + 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 line break control level for the document. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + artWidth?: number; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + color?: string; /** - * Specifies the character spacing adjustment for the template. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm?: boolean; + inside?: boolean; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + isVisible?: boolean; /** - * Specifies an East Asian language for the language in the template. + * Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + 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 kinsoku characters after which Microsoft Word will not break a line. + * Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter?: string; + 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 { /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore?: string; + range?: Word.Interfaces.RangeData; /** - * 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. + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved?: boolean; - } - /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ - interface TemplateCollectionUpdateData { - items?: Word.Interfaces.TemplateData[]; + pageIndex?: number; } - /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ - interface TrackedChangeCollectionUpdateData { - items?: Word.Interfaces.TrackedChangeData[]; + /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ + interface BreakCollectionData { + items?: Word.Interfaces.BreakData[]; } - /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ - interface ShapeUpdateData { + /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ + interface BuildingBlockData { /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Specifies the description for the building block. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + description?: string; /** - * 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}. + * Returns the internal identification number for the building block. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - canvas?: Word.Interfaces.CanvasUpdateData; + id?: string; /** - * Returns the fill formatting of the shape. + * Returns the position of this building block in a collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fill?: Word.Interfaces.ShapeFillUpdateData; + index?: number; /** - * 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. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeUpdateData; + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; /** - * 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. + * Specifies the name of the building block. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeUpdateData; + name?: string; /** - * 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}. + * Specifies the contents of the building block. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; + value?: string; + } + /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ + interface BuildingBlockCategoryData { /** - * Gets the text frame object of the shape. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameUpdateData; + index?: number; /** - * Returns the text wrap formatting of the shape. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; + name?: string; + } + /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ + interface BuildingBlockTypeItemData { /** - * Specifies whether a given shape can overlap other shapes. + * Returns the position of an item in a collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + index?: number; /** - * Specifies a string that represents the alternative text associated with the shape. + * Returns the localized name of a building block type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + name?: string; + } + /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ + interface CheckboxContentControlData { /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the current state of the checkbox. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - 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"; + isChecked?: boolean; + } + /** An interface describing the data returned by calling `comment.toJSON()`. */ + interface CommentData { /** - * The height, in points, of the shape. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - height?: number; + authorEmail?: string; /** - * 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 the name of the comment's author. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - heightRelative?: number; + authorName?: string; /** - * 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 comment's content as plain text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - left?: number; + content?: string; /** - * 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 the creation date of the comment. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - leftRelative?: number; + creationDate?: Date; /** - * Specifies if the aspect ratio of this shape is locked. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - lockAspectRatio?: boolean; + id?: string; /** - * The name of the shape. + * 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.2] + * [Api set: WordApi 1.4] */ - name?: string; + 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 { /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + bold?: 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 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.2] + * [Api set: WordApi 1.4] */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + hyperlink?: string; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + isEmpty?: 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 a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + italic?: boolean; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - rotation?: number; + strikeThrough?: 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 text of the comment range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - top?: number; + text?: string; /** - * 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 a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - topRelative?: number; + 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 if the shape is visible. Not applicable to inline shapes. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - visible?: boolean; + authorEmail?: string; /** - * The width, in points, of the shape. + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - width?: number; + authorName?: string; /** - * 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 comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - widthRelative?: number; - } - /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ - interface ShapeGroupUpdateData { + content?: string; /** - * Gets the Shape object associated with the group. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - shape?: Word.Interfaces.ShapeUpdateData; - } - /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ - interface CanvasUpdateData { + creationDate?: Date; /** - * Gets the Shape object associated with the canvas. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - shape?: Word.Interfaces.ShapeUpdateData; + id?: string; } - /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ - interface ShapeCollectionUpdateData { - items?: Word.Interfaces.ShapeData[]; + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ + interface CommentReplyCollectionData { + items?: Word.Interfaces.CommentReplyData[]; } - /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ - interface ShapeFillUpdateData { + /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ + interface XmlMappingData { /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * 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.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + customXmlNode?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: string; + customXmlPart?: Word.Interfaces.CustomXmlPartData; /** - * 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. + * 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.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency?: number; - } - /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ - interface TextFrameUpdateData { + isMapped?: boolean; /** - * 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. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + prefixMappings?: string; /** - * Represents the bottom margin, in points, of the text frame. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + 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 { /** - * Represents the left margin, in points, of the text frame. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + namespaceUri?: string; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + prefix?: string; + } + /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ + interface CustomXmlSchemaData { /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Gets the location of the schema on a computer. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + location?: string; /** - * Represents the right margin, in points, of the text frame. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: number; + 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 `customXmlValidationErrorCollection.toJSON()`. */ + interface CustomXmlValidationErrorCollectionData { + items?: Word.Interfaces.CustomXmlValidationErrorData[]; + } + /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ + interface CustomXmlValidationErrorData { /** - * Represents the top margin, in points, of the text frame. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin?: number; + node?: Word.Interfaces.CustomXmlNodeData; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + errorCode?: number; /** - * Determines whether lines break automatically to fit text inside the shape. + * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap?: boolean; - } - /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ - interface ShapeTextWrapUpdateData { + name?: string; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Gets the text in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: number; + text?: string; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; + } + /** 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 { /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + attributes?: Word.Interfaces.CustomXmlNodeData[]; /** - * 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 a `CustomXmlNodeCollection` object containing all of the child elements of the current node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + childNodes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * 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.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: number; + firstChild?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * 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.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + lastChild?: Word.Interfaces.CustomXmlNodeData; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ - interface DatePickerContentControlUpdateData { + nextSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + ownerPart?: Word.Interfaces.CustomXmlPartData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + parentNode?: Word.Interfaces.CustomXmlNodeData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + previousSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the appearance of the content control. + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + baseName?: string; /** - * 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 unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + namespaceUri?: string; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Gets the type of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; /** - * Specifies the format in which dates are displayed. + * Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: string; + nodeValue?: string; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + text?: string; /** - * 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 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 BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + xpath?: string; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the XML representation of the current node and its children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + xml?: string; + } + /** An interface describing the data returned by calling `contentControl.toJSON()`. */ + interface ContentControlData { /** - * 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 building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; /** - * 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 data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - lockContents?: boolean; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; /** - * Specifies a tag to identify the content control. + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - tag?: string; + comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** - * Specifies the title for the content control. + * Gets the collection of content control objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - title?: string; - } - /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ - interface PictureContentControlUpdateData { + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - range?: Word.Interfaces.RangeUpdateData; + dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the collection of field objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the appearance of the content control. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + font?: Word.Interfaces.FontData; /** - * 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 group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + groupContentControl?: Word.Interfaces.GroupContentControlData; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isTemporary?: boolean; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * 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 collection of list objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - lockContentControl?: boolean; + lists?: Word.Interfaces.ListData[]; /** - * 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 collection of paragraph objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [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. */ - lockContents?: boolean; + paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Specifies a tag to identify the content control. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + pictureContentControl?: Word.Interfaces.PictureContentControlData; /** - * Specifies the title for the content control. + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ - interface GroupContentControlUpdateData { + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the collection of table objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + tables?: Word.Interfaces.TableData[]; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * 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 BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the appearance of the content control. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + cannotDelete?: 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 a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [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 whether to remove the content control from the active document when the user edits the contents of the control. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isTemporary?: boolean; + id?: 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 placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - lockContentControl?: boolean; + placeholderText?: string; /** - * 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 a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - lockContents?: boolean; + removeWhenEdited?: boolean; /** - * Specifies a tag to identify the content control. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [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, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox 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; /** - * Specifies the title for the content control. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [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, and checkbox 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 for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ - interface BuildingBlockGalleryContentControlUpdateData { + /** 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 { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + displayText?: string; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - range?: Word.Interfaces.RangeUpdateData; + index?: number; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + 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 { /** - * Specifies the appearance of the content control. + * Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + key?: string; /** - * Specifies the category for the building block content control. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - buildingBlockCategory?: string; + type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 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"; + 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 { /** - * 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 root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + documentElement?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + errors?: Word.Interfaces.CustomXmlValidationErrorData[]; /** - * 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 set of namespace prefix mappings used against the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; /** - * 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 a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; /** - * Specifies a tag to identify the content control. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + builtIn?: boolean; /** - * Specifies the title for the content control. + * Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - title?: string; - } - /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ - interface RepeatingSectionContentControlUpdateData { + id?: string; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + namespaceUri?: string; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + 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 { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the active window for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - xmlapping?: Word.Interfaces.XmlMappingUpdateData; + activeWindow?: Word.Interfaces.WindowData; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + bibliography?: Word.Interfaces.BibliographyData; /** - * Specifies the appearance of the content control. + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + body?: Word.Interfaces.BodyData; /** - * 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 collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - color?: string; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the custom XML parts in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isTemporary?: boolean; + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; /** - * 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 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; /** - * 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. + * Returns a `FrameCollection` object that represents all the frames in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + frames?: Word.Interfaces.FrameData[]; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: string; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Specifies a tag to identify the content control. + * Returns a `PageSetup` object that's associated with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + pageSetup?: Word.Interfaces.PageSetupData; /** - * Specifies the title for the content control. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - title?: string; - } - /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ - interface FrameUpdateData { + properties?: Word.Interfaces.DocumentPropertiesData; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - range?: Word.Interfaces.RangeUpdateData; + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + sections?: Word.Interfaces.SectionData[]; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + settings?: Word.Interfaces.SettingData[]; /** - * Specifies the height (in points) of the frame. + * Gets the collection of `Word.Window` objects for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - height?: number; + windows?: Word.Interfaces.WindowData[]; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + autoHyphenation?: boolean; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies if the edits in the document are automatically saved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: number; + autoSaveOn?: boolean; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: number; + consecutiveHyphensLimit?: number; /** - * Specifies if the frame is locked. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + hyphenateCaps?: boolean; /** - * Specifies the relative horizontal position of the frame. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + languageDetected?: 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + saved?: boolean; + } + /** 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 content control 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[]; /** - * Specifies the relative vertical position of the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + settings?: Word.Interfaces.SettingData[]; /** - * Specifies if document text wraps around the frame. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - textWrap?: boolean; + saved?: boolean; + } + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ + interface DocumentPropertiesData { /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - verticalDistanceFromText?: number; + applicationName?: string; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies the author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - verticalPosition?: number; + author?: string; /** - * Specifies the width (in points) of the frame. + * Specifies the category of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - width?: number; + category?: string; /** - * Specifies the rule used to determine the width of the frame. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + comments?: string; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Specifies the company of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; - /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + company?: string; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Gets the creation date of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - gradientAngle?: number; + creationDate?: Date; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the format of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVisible?: boolean; + format?: string; /** - * Specifies whether the fill rotates with the shape. + * Specifies the keywords of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - rotateWithObject?: boolean; + keywords?: string; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Gets the last author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + lastAuthor?: string; /** - * Specifies the horizontal scaling factor for the texture fill. + * Gets the last print date of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textureHorizontalScale?: number; + lastPrintDate?: Date; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Gets the last save time of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textureOffsetX?: number; + lastSaveTime?: Date; /** - * Specifies the vertical offset of the texture. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textureOffsetY?: number; + manager?: string; /** - * Specifies whether the texture is tiled. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textureTile?: boolean; + revisionNumber?: string; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textureVerticalScale?: number; + security?: number; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the subject of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - color?: Word.Interfaces.ColorFormatUpdateData; + subject?: string; /** - * Specifies the length of the radius for a glow effect. + * Gets the template of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - radius?: number; + template?: string; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the title of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - transparency?: number; + title?: string; } - /** 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + /** 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 a `ColorFormat` object that represents the foreground color for the line. + * Gets the field's result data. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + result?: Word.Interfaces.RangeData; /** - * Specifies the length of the arrowhead at the beginning of the line. + * Specifies the field's code instruction. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; - /** - * Specifies the style of the arrowhead at the beginning of the line. + * [Api set: WordApi 1.4] * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Note: The ability to set the code was introduced in WordApi 1.5. */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + code?: string; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + data?: string; /** - * Specifies the dash style for the line. + * Gets the field's kind. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; /** - * Specifies the length of the arrowhead at the end of the line. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + locked?: boolean; /** - * Specifies the style of the arrowhead at the end of the line. + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + showCodes?: boolean; /** - * Specifies the width of the arrowhead at the end of the line. + * Gets the field's type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + 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 { /** - * Specifies if to draw lines inside a shape. + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insetPen?: boolean; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + fill?: Word.Interfaces.FillFormatData; /** - * Specifies the pattern applied to the line. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + glow?: Word.Interfaces.GlowFormatData; /** - * Specifies the line format style. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + line?: Word.Interfaces.LineFormatData; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + reflection?: Word.Interfaces.ReflectionFormatData; /** - * Specifies the thickness of the line in points. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight?: number; - } - /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ - interface ReflectionFormatUpdateData { + textColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + textShadow?: Word.Interfaces.ShadowFormatData; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset?: number; + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + allCaps?: boolean; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - transparency?: number; + bold?: boolean; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + boldBidirectional?: boolean; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - brightness?: number; + color?: string; /** - * Specifies the theme color for a color format. + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + 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 red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb?: string; + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies whether contextual alternates are enabled for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + contextualAlternates?: boolean; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + diacriticColor?: string; /** - * Specifies whether the object or the formatting applied to it is visible. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + disableCharacterSpaceGrid?: 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. + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - obscured?: boolean; + doubleStrikeThrough?: 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. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX?: number; + emboss?: 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 an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: number; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Specifies whether to rotate the shadow when rotating the shape. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + engrave?: boolean; /** - * Specifies the width of the shadow. + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - size?: number; + hidden?: boolean; /** - * Specifies the type of shadow formatting to apply to a shape. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + highlightColor?: string; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - transparency?: number; + italic?: boolean; /** - * Specifies the shape shadow type. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - contourColor?: Word.Interfaces.ColorFormatUpdateData; - /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - extrusionColor?: Word.Interfaces.ColorFormatUpdateData; + italicBidirectional?: boolean; /** - * Specifies the depth of the bottom bevel. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomDepth?: number; + kerning?: number; /** - * Specifies the inset size for the bottom bevel. + * Specifies the ligature setting for the `Font` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset?: number; + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Specifies a value that represents the name of the font. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + name?: string; /** - * Specifies the depth of the top bevel. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth?: number; + nameAscii?: string; /** - * Specifies the inset size for the top bevel. + * Specifies the font name in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset?: number; + nameBidirectional?: string; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * Specifies the East Asian font name. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + nameFarEast?: string; /** - * Specifies the width of the contour of a shape. + * Specifies the font used for characters with codes from 128 through 255. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: number; + nameOther?: string; /** - * Specifies the depth of the shape's extrusion. + * Specifies the number form setting for an OpenType font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth?: number; + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; /** - * 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 number spacing setting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; /** - * Specifies the amount of perspective for a shape. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView?: number; + outline?: 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. + * Specifies the position of text (in points) relative to the base line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective?: boolean; + position?: number; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Specifies the scaling percentage applied to the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + scaling?: number; /** - * Specifies the angle of the lighting. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: number; + shadow?: boolean; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Specifies a value that represents the font size in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 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"; + size?: number; /** - * Specifies the position of the light source relative to the extrusion. + * Specifies the font size in points for right-to-left text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + sizeBidirectional?: number; /** - * Specifies the intensity of the extrusion lighting. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + smallCaps?: boolean; /** - * Specifies the extrusion surface material. + * Specifies the spacing between characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + spacing?: number; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - projectText?: boolean; + strikeThrough?: boolean; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Specifies the stylistic set for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX?: number; + 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 the rotation of the extruded shape around the y-axis in degrees. + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rotationY?: number; + subscript?: boolean; /** - * Specifies the z-axis rotation of the camera. + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rotationZ?: number; + superscript?: boolean; /** - * Specifies the position on the z-axis for the shape. + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - z?: number; - } - /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ - interface BibliographyUpdateData { + 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 name of the active style to use for the bibliography. + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle?: string; - } - /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ - interface SourceCollectionUpdateData { - items?: Word.Interfaces.SourceData[]; + underlineColor?: string; } - /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ - interface PageSetupUpdateData { + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + interface HyperlinkData { /** - * 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 within the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineNumbering?: Word.Interfaces.LineNumberingUpdateData; + range?: Word.Interfaces.RangeData; /** - * Specifies whether Microsoft Word prints the document as a booklet. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrinting?: boolean; + address?: string; /** - * Specifies the number of pages for each booklet. + * Specifies the text string for the hyperlink's subject line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrintingSheets?: number; + emailSubject?: string; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting?: boolean; + isExtraInfoRequired?: boolean; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Returns the name of the `Hyperlink` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomMargin?: number; + name?: string; /** - * Specifies the number of characters per line in the document grid. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine?: number; + screenTip?: string; /** - * Specifies whether the first page has a different header and footer. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter?: boolean; + subAddress?: string; /** - * Specifies the distance between the footer and the bottom of the page in points. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance?: number; + target?: string; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter?: number; + textToDisplay?: string; /** - * Specifies on which side the gutter appears in a document. + * Returns the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + 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 whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + altTextDescription?: string; /** - * Specifies the distance between the header and the top of the page in points. + * Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - headerDistance?: number; + altTextTitle?: string; /** - * Specifies the layout mode for the current document. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + height?: number; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - leftMargin?: number; + hyperlink?: string; /** - * Specifies the number of lines per page in the document grid. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - linesPage?: number; + imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - mirrorMargins?: boolean; + lockAspectRatio?: boolean; /** - * Specifies whether odd and even pages have different headers and footers. + * Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - oddAndEvenPagesHeaderFooter?: boolean; + 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 the orientation of the page. + * 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 */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + isAutoUpdated?: boolean; /** - * Specifies the page height in points. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageHeight?: number; + isLocked?: boolean; /** - * Specifies the page width in points. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageWidth?: number; + isPictureSavedWithDocument?: boolean; /** - * Specifies the paper size of the page. + * 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 */ - 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"; + sourceFullName?: string; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightMargin?: number; + sourceName?: string; /** - * Specifies the reading order and alignment for the specified sections. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + sourcePath?: string; /** - * Specifies the type of section break for the specified object. + * Gets the link type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; + } + /** An interface describing the data returned by calling `list.toJSON()`. */ + interface ListData { /** - * Specifies whether to show the grid. + * Gets paragraphs in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * Gets the list's id. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - showGrid?: boolean; + id?: number; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - suppressEndnotes?: boolean; + levelExistences?: boolean[]; /** - * Specifies the top margin of the page in points. + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - topMargin?: number; + 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 whether to print two pages per sheet. + * Specifies the level of the item in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - twoPagesOnOne?: boolean; + level?: number; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Gets the list item bullet, number, or picture as a string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + listString?: string; + /** + * Gets the list item order number in relation to its siblings. + * + * @remarks + * [Api set: WordApi 1.3] + */ + siblingIndex?: number; } - /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ - interface LineNumberingUpdateData { + /** An interface describing the data returned by calling `listLevel.toJSON()`. */ + interface ListLevelData { /** - * Specifies the numeric increment for line numbers. + * Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - countBy?: number; + font?: Word.Interfaces.FontData; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - distanceFromText?: number; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isActive?: boolean; + linkedStyle?: string; /** - * 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 the number format for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + numberFormat?: string; /** - * Specifies the starting line number. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - 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 { + numberPosition?: number; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spaceAfter?: number; + 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 width, in points, of the specified text columns. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - width?: number; - } - /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ - interface CritiqueAnnotationData { + resetOnHigher?: number; /** - * Gets the critique that was passed when the annotation was inserted. + * Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.1] */ - critique?: Word.Critique; - } - /** An interface describing the data returned by calling `annotation.toJSON()`. */ - interface AnnotationData { + startAt?: number; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.1] */ - id?: string; + tabPosition?: number; /** - * Gets the state of the annotation. + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.1] */ - 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 { + textPosition?: number; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bibliography?: Word.Interfaces.BibliographyData; + 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 { /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Gets a `ListLevelCollection` object that represents all the levels for the list template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - checkLanguage?: boolean; + listLevels?: Word.Interfaces.ListLevelData[]; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - 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"; + outlineNumbered?: boolean; } - /** An interface describing the data returned by calling `body.toJSON()`. */ - interface BodyData { + /** An interface describing the data returned by calling `noteItem.toJSON()`. */ + interface NoteItemData { /** - * Gets the collection of rich text content control objects in the body. + * 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.1] + * [Api set: WordApi 1.5] */ - contentControls?: Word.Interfaces.ContentControlData[]; + body?: Word.Interfaces.BodyData; /** - * Gets the collection of field objects in the body. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - fields?: Word.Interfaces.FieldData[]; + reference?: Word.Interfaces.RangeData; /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - font?: Word.Interfaces.FontData; + 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 { /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + classType?: string; /** - * Gets the collection of list objects in the body. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lists?: Word.Interfaces.ListData[]; + iconIndex?: number; /** - * Gets the collection of paragraph objects in the body. + * Specifies the text displayed below the icon for the OLE object. * * @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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphs?: Word.Interfaces.ParagraphData[]; + iconLabel?: string; /** - * 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. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + iconName?: string; /** - * Gets the collection of table objects in the body. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tables?: Word.Interfaces.TableData[]; + iconPath?: string; /** - * 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. + * Gets whether the specified object is displayed as an icon. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + isDisplayedAsIcon?: 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. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + isFormattingPreservedOnUpdate?: boolean; /** - * Gets the text of the body. Use the insertText method to insert text. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + label?: 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 WordApiOnline 1.1 and later. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; + progID?: string; } - /** An interface describing the data returned by calling `border.toJSON()`. */ - interface BorderData { + /** An interface describing the data returned by calling `page.toJSON()`. */ + interface PageData { /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Gets a `BreakCollection` object that represents the breaks on the page. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + breaks?: Word.Interfaces.BreakData[]; /** - * Gets the location of the border. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; + height?: number; /** - * Specifies the border type for the border. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - 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"; + index?: number; /** - * Specifies whether the border is visible. + * Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - visible?: boolean; + 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 { /** - * Specifies the width for the border. + * Gets the collection of pages in the pane. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + 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 `borderUniversal.toJSON()`. */ - interface BorderUniversalData { + /** 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 { /** - * Specifies the graphical page-border design for the document. + * Gets the next document window in the collection of open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + next?: Word.Interfaces.WindowData; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Gets the previous document window in the collection open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: number; + previous?: Word.Interfaces.WindowData; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies whether rulers are displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + areRulersDisplayed?: boolean; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + areScreenTipsDisplayed?: boolean; /** - * Returns `true` if an inside border can be applied to the specified object. + * 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 */ - inside?: boolean; + areThumbnailsDisplayed?: boolean; /** - * Specifies whether the border is visible. + * 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 */ - isVisible?: boolean; + caption?: string; /** - * Specifies the line style of the border. + * Specifies the height of the window (in points). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + height?: number; /** - * Specifies the line width of an object's border. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + horizontalPercentScrolled?: number; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + imemode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** - * Returns the page number on which the break occurs. + * Gets the position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + index?: number; /** - * Specifies the description for the building block. + * Specifies whether the window is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + isActive?: boolean; /** - * Returns the internal identification number for the building block. + * Specifies whether the document map is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + isDocumentMapVisible?: boolean; /** - * Returns the position of this building block in a 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 */ - index?: number; + isEnvelopeVisible?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + isHorizontalScrollBarDisplayed?: boolean; /** - * Specifies the name of the building block. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + isLeftScrollBarDisplayed?: boolean; /** - * Specifies the contents of the building block. + * 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 */ - value?: string; - } - /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ - interface BuildingBlockCategoryData { + isRightRulerDisplayed?: boolean; /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * Specifies whether the window is split into multiple panes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + isSplit?: boolean; /** - * Returns the name of the `BuildingBlockCategory` object. + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ - interface BuildingBlockTypeItemData { + isVerticalRulerDisplayed?: boolean; /** - * Returns the position of an item in a collection. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + isVerticalScrollBarDisplayed?: boolean; /** - * Returns the localized name of a building block type. + * Specifies whether the window is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 `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[]; + isVisible?: boolean; /** - * Gets the email of the comment's author. + * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: string; + left?: number; /** - * Gets the name of the comment's author. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: string; + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** - * Specifies the comment's content as plain text. + * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; + splitVertical?: number; /** - * Gets the creation date of the comment. + * Specifies the width of the style area in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: Date; + styleAreaWidth?: number; /** - * Gets the ID of the comment. + * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + top?: 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. + * Gets the window type. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + type?: Word.WindowType | "Document" | "Template"; /** - * Specifies a value that indicates whether the comment text is bold. + * Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + usableHeight?: 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. + * Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + usableWidth?: number; /** - * Checks whether the range length is zero. + * Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isEmpty?: boolean; + verticalPercentScrolled?: number; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + width?: number; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + windowNumber?: number; /** - * Gets the text of the comment range. + * Specifies the state of the document window or task window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + } + /** 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 { /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Gets the email of the comment reply's author. + * Gets the collection of fields in the paragraph. * * @remarks * [Api set: WordApi 1.4] */ - authorEmail?: string; + fields?: Word.Interfaces.FieldData[]; /** - * Gets the name of the comment reply's author. + * 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] */ - authorName?: string; + font?: Word.Interfaces.FontData; /** - * Specifies the comment reply's content. The string is plain text. + * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: string; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the creation date of the comment reply. + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - creationDate?: Date; + listItem?: Word.Interfaces.ListItemData; /** - * Gets the ID of the comment reply. + * 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.4] + * [Api set: WordApi 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 { + listItemOrNullObject?: Word.Interfaces.ListItemData; /** - * 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 `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlNode?: Word.Interfaces.CustomXmlNodeData; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - customXmlPart?: Word.Interfaces.CustomXmlPartData; + shapes?: Word.Interfaces.ShapeData[]; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isMapped?: boolean; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - prefixMappings?: string; + firstLineIndent?: number; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 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 { + isLastParagraph?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - namespaceUri?: string; + isListItem?: boolean; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - prefix?: string; - } - /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ - interface CustomXmlSchemaData { + leftIndent?: number; /** - * Gets the location of the schema on a computer. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - location?: string; + lineSpacing?: number; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - 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 `customXmlValidationErrorCollection.toJSON()`. */ - interface CustomXmlValidationErrorCollectionData { - items?: Word.Interfaces.CustomXmlValidationErrorData[]; - } - /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ - interface CustomXmlValidationErrorData { + lineUnitAfter?: number; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - node?: Word.Interfaces.CustomXmlNodeData; + lineUnitBefore?: number; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - errorCode?: number; + outlineLevel?: number; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - name?: string; + rightIndent?: number; /** - * Gets the text in the `CustomXmlValidationError` object. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - text?: string; + spaceAfter?: number; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; - } - /** 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 { + spaceBefore?: number; /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - attributes?: Word.Interfaces.CustomXmlNodeData[]; + style?: string; /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - childNodes?: Word.Interfaces.CustomXmlNodeData[]; + 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 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 level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - firstChild?: Word.Interfaces.CustomXmlNodeData; + tableNestingLevel?: number; /** - * 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 of the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - lastChild?: Word.Interfaces.CustomXmlNodeData; + text?: string; /** - * 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 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - nextSibling?: Word.Interfaces.CustomXmlNodeData; + uniqueLocalId?: string; + } + /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ + interface ParagraphCollectionData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ + interface ParagraphFormatData { /** - * Gets the object representing the part associated with this node. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - ownerPart?: Word.Interfaces.CustomXmlPartData; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - parentNode?: Word.Interfaces.CustomXmlNodeData; + firstLineIndent?: 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`. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - previousSibling?: Word.Interfaces.CustomXmlNodeData; + keepTogether?: boolean; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - baseName?: string; + keepWithNext?: boolean; /** - * Gets the unique address identifier for the namespace of the node. + * Specifies the left indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - namespaceUri?: string; + leftIndent?: number; /** - * Gets the type of the current node. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + lineSpacing?: number; /** - * Specifies the value of the current node. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - nodeValue?: string; + lineUnitAfter?: number; /** - * Specifies the text for the current node. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - text?: string; + lineUnitBefore?: 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 left and right indents are the same width. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - xpath?: string; + mirrorIndents?: boolean; /** - * Gets the XML representation of the current node and its children. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - xml?: string; - } - /** An interface describing the data returned by calling `contentControl.toJSON()`. */ - interface ContentControlData { + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; + rightIndent?: number; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.5] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; + spaceAfter?: number; /** - * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.5] */ - comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; + spaceBefore?: number; /** - * Gets the collection of content control objects in the content control. + * 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.1] + * [Api set: WordApi 1.5] */ - contentControls?: Word.Interfaces.ContentControlData[]; + widowControl?: boolean; + } + /** An interface describing the data returned by calling `range.toJSON()`. */ + interface RangeData { /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Gets the collection of field objects in the content control. + * Gets the collection of field objects in the range. * * @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. + * 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.FontData; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Gets a `FrameCollection` object that represents all the frames in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - groupContentControl?: Word.Interfaces.GroupContentControlData; + frames?: Word.Interfaces.FrameData[]; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Gets the collection of list objects in the content control. + * Gets the collection of inline picture objects in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.2] */ - lists?: Word.Interfaces.ListData[]; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the collection of paragraph objects in the content control. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listFormat?: Word.Interfaces.ListFormatData; + /** + * Gets the collection of pages in the range. * - * 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. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - paragraphs?: Word.Interfaces.ParagraphData[]; + pages?: Word.Interfaces.PageData[]; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Gets the collection of sections in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlData; + sections?: Word.Interfaces.SectionData[]; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Gets the collection of table objects in the content control. + * 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] */ - tables?: Word.Interfaces.TableData[]; + shapes?: Word.Interfaces.ShapeData[]; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets a `TableColumnCollection` object that represents all the table columns in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + tableColumns?: Word.Interfaces.TableColumnData[]; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + bold?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotDelete?: boolean; + boldBidirectional?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotEdit?: boolean; + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies the character width of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** - * Gets an integer that represents the content control identifier. + * Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + combineCharacters?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - placeholderText?: string; + disableCharacterSpaceGrid?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeWhenEdited?: boolean; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * 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 ending character position of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + end?: 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 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + fitTextWidth?: number; /** - * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: string; + hasNoProofing?: boolean; /** - * Gets the text of the content control. + * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + 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 title for a content control. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: string; + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * 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?: 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 { + hyperlink?: string; /** - * Specifies the display text 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: string; + id?: string; /** - * Specifies the index location of a content control list item in the collection of list items. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.3] */ - index?: number; + isEmpty?: boolean; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + isEndOfRowMark?: boolean; /** - * Gets the key of the custom property. + * Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + isTextVisibleOnScreen?: boolean; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; + italic?: 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). + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + italicBidirectional?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeData; + kana?: Word.Kana | "Katakana" | "Hiragana"; /** - * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - errors?: Word.Interfaces.CustomXmlValidationErrorData[]; + languageDetected?: boolean; /** - * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; + 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 a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; + 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 a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: 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"; /** - * Gets the ID of the custom XML part. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + showAll?: boolean; /** - * Gets the namespace URI of the custom XML part. + * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: string; + spellingChecked?: boolean; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the starting character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + start?: number; /** - * Gets the active window for the document. + * Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowData; + storyLength?: number; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Gets the story type for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyData; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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] */ - body?: Word.Interfaces.BodyData; + style?: string; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * 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] */ - contentControls?: Word.Interfaces.ContentControlData[]; + 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 custom XML parts in the document. + * Gets the text of the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + text?: string; /** - * 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. + * 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 */ - documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; /** - * Returns a `FrameCollection` object that represents all the frames in the document. + * Specifies the type of underline applied to the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frames?: Word.Interfaces.FrameData[]; + underline?: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; + } + /** 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 { /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + ignorePunct?: boolean; /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageSetup?: Word.Interfaces.PageSetupData; + ignoreSpace?: boolean; /** - * Gets the properties of the document. + * Specifies a value that indicates whether to perform a case sensitive search. 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] */ - properties?: Word.Interfaces.DocumentPropertiesData; + matchCase?: boolean; /** - * Gets the collection of section objects in the document. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - sections?: Word.Interfaces.SectionData[]; + matchPrefix?: boolean; /** - * Gets the add-in's settings in the document. + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - settings?: Word.Interfaces.SettingData[]; + matchSuffix?: boolean; /** - * Gets the collection of `Word.Window` objects for the document. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - windows?: Word.Interfaces.WindowData[]; + matchWholeWord?: boolean; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - autoHyphenation?: boolean; + matchWildcards?: boolean; + } + /** An interface describing the data returned by calling `section.toJSON()`. */ + interface SectionData { /** - * Specifies if the edits in the document are automatically saved. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - autoSaveOn?: boolean; + body?: Word.Interfaces.BodyData; /** - * Specifies the ChangeTracking mode. + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: number; + pageSetup?: Word.Interfaces.PageSetupData; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies if the section is protected for forms. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + 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 Microsoft Word has detected the language of the document text. + * Gets the key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - languageDetected?: boolean; + key?: string; /** - * 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 value of the setting. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - saved?: boolean; + value?: any; } - /** 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 content control 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; + /** 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 { /** - * Gets the collection of section objects in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - sections?: Word.Interfaces.SectionData[]; + * Specifies a BorderCollection object that represents all the borders for the specified style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + borders?: Word.Interfaces.BorderData[]; /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - settings?: Word.Interfaces.SettingData[]; + * Gets a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + font?: Word.Interfaces.FontData; /** - * 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 `Frame` object that represents the frame formatting for the style. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; - } - /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ - interface DocumentPropertiesData { + frame?: Word.Interfaces.FrameData; /** - * Gets the collection of custom properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - customProperties?: Word.Interfaces.CustomPropertyData[]; + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + linkStyle?: Word.Interfaces.StyleData; /** - * Gets the application name of the document. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - applicationName?: string; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * Specifies the author of the document. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - author?: string; + paragraphFormat?: Word.Interfaces.ParagraphFormatData; /** - * Specifies the category of the document. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - category?: string; + shading?: Word.Interfaces.ShadingData; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - comments?: string; + tableStyle?: Word.Interfaces.TableStyleData; /** - * Specifies the company of the document. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - company?: string; + automaticallyUpdate?: boolean; /** - * Gets the creation date of the document. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - creationDate?: Date; + baseStyle?: string; /** - * Specifies the format of the document. + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - format?: string; + builtIn?: boolean; /** - * Specifies the keywords of the document. + * Gets the description of the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keywords?: string; + description?: string; /** - * Gets the last author of the document. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastAuthor?: string; + hasProofing?: boolean; /** - * Gets the last print date of the document. + * Gets whether the specified 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] + * [Api set: WordApi 1.5] */ - lastPrintDate?: Date; + inUse?: boolean; /** - * Gets the last save time of the document. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastSaveTime?: Date; + 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 manager of the document. + * Specifies an East Asian language for the style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - manager?: 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 revision number of the document. + * Gets whether a 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] */ - revisionNumber?: string; + linked?: 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. + * Returns the list level for the style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - security?: number; + listLevelNumber?: number; /** - * Specifies the subject of the document. + * Specifies whether the style cannot be changed or edited. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subject?: string; + locked?: boolean; /** - * Gets the template of the document. + * Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - template?: string; + nameLocal?: string; /** - * Specifies the title 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 specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - 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; + nextParagraphStyle?: string; /** - * Specifies the field's code instruction. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - code?: string; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Specifies the priority. * * @remarks * [Api set: WordApi 1.5] */ - data?: string; + priority?: number; /** - * Gets the field's kind. + * Specifies whether the style corresponds to an available quick style. * * @remarks * [Api set: WordApi 1.5] */ - kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + quickStyle?: boolean; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Gets the style type. * * @remarks * [Api set: WordApi 1.5] */ - locked?: boolean; + type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - showCodes?: boolean; + unhideWhenUsed?: boolean; /** - * Gets the field's type. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @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[]; + visibility?: boolean; } - /** An interface describing the data returned by calling `font.toJSON()`. */ - interface FontData { + /** An interface describing the data returned by calling `shading.toJSON()`. */ + interface ShadingData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - borders?: Word.Interfaces.BorderUniversalData[]; + backgroundPatternColor?: string; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - fill?: Word.Interfaces.FillFormatData; + foregroundPatternColor?: string; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - glow?: Word.Interfaces.GlowFormatData; + 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 { /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * 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 BETA (PREVIEW ONLY)] * @beta */ - line?: Word.Interfaces.LineFormatData; + backgroundPatternColor?: string; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatData; + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Returns a `ColorFormat` object that represents the color for the font. + * 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 BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatData; + foregroundPatternColor?: string; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - textShadow?: Word.Interfaces.ShadowFormatData; + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for 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 BETA (PREVIEW ONLY)] * @beta */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; + 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 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 the collection of field objects in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - allCaps?: boolean; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - bold?: boolean; + font?: Word.Interfaces.FontData; /** - * 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 all of the table rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - boldBidirectional?: boolean; + rows?: Word.Interfaces.TableRowData[]; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the child tables nested one level deeper. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - color?: string; + tables?: Word.Interfaces.TableData[]; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 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"; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 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"; + headerRowCount?: number; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - contextualAlternates?: boolean; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - diacriticColor?: string; + isUniform?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - disableCharacterSpaceGrid?: boolean; + nestingLevel?: number; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - doubleStrikeThrough?: boolean; + rowCount?: number; /** - * 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 shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - emboss?: boolean; + shadingColor?: string; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + style?: string; /** - * 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 whether the table has banded columns. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - engrave?: boolean; + styleBandedColumns?: boolean; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - hidden?: boolean; + styleBandedRows?: 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. + * 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.1] + * [Api set: WordApi 1.3] */ - highlightColor?: 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 a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - italic?: boolean; + styleFirstColumn?: 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 table has a last column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - italicBidirectional?: boolean; + styleLastColumn?: boolean; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - kerning?: number; + styleTotalRow?: boolean; /** - * Specifies the ligature setting for the `Font` object. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + values?: string[][]; /** - * Specifies a value that represents the name of the font. + * 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] */ - name?: string; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nameAscii?: string; + width?: number; + } + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ + interface TableStyleData { /** - * Specifies the font name in a right-to-left language document. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameBidirectional?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the East Asian font name. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameFarEast?: string; + allowBreakAcrossPage?: boolean; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - nameOther?: string; + bottomCellMargin?: number; /** - * Specifies the number form setting for an OpenType font. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + cellSpacing?: number; /** - * Specifies the number spacing setting for the font. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + leftCellMargin?: number; /** - * 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 amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - outline?: boolean; + rightCellMargin?: number; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - position?: number; + topCellMargin?: number; + } + /** An interface describing the data returned by calling `tabStop.toJSON()`. */ + interface TabStopData { /** - * Specifies the scaling percentage applied to the font. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaling?: number; + alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * 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. + * Gets whether this tab stop is a custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shadow?: boolean; - /** - * Specifies a value that represents the font size in points. - * - * @remarks - * [Api set: WordApi 1.1] - */ - size?: number; + customTab?: boolean; /** - * Specifies the font size in points for right-to-left text. + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sizeBidirectional?: number; + leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * 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. + * Gets the position of the tab stop relative to the left margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + position?: number; + } + /** 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 { /** - * Specifies the spacing between characters. + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; - /** - * Specifies a value that indicates 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; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the stylistic set for the font. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 a value that indicates 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 a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. - * - * @remarks - * [Api set: WordApi 1.1] - */ - superscript?: boolean; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Returns the position of this column in a collection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + columnIndex?: number; /** - * Specifies the color of the underline for the `Font` object. 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - underlineColor?: string; - } - /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ - interface HyperlinkData { + isFirst?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + isLast?: boolean; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: string; + nestingLevel?: number; /** - * Specifies the text string for the hyperlink's subject line. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: string; + preferredWidth?: number; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isExtraInfoRequired?: boolean; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Returns the name of the `Hyperlink` object. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + 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 { /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * 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; + /** + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - screenTip?: string; + cellCount?: number; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - subAddress?: string; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - target?: string; + isHeader?: boolean; /** - * Specifies the hyperlink's visible text in the document. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textToDisplay?: string; + preferredHeight?: number; /** - * Returns the hyperlink type. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 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 { + rowIndex?: number; /** - * Specifies a string that represents the alternative text associated with the inline image. + * 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] */ - altTextDescription?: string; + shadingColor?: string; /** - * Specifies a string that contains the title for the inline image. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - altTextTitle?: string; + values?: string[][]; /** - * Specifies a number that describes the height of the inline image. + * 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] */ - height?: number; + 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 { /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - hyperlink?: string; + body?: Word.Interfaces.BodyData; /** - * Gets the format of the inline image. + * Gets the index of the cell in its row. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + cellIndex?: number; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * 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] */ - lockAspectRatio?: boolean; + columnWidth?: number; /** - * Specifies a number that describes the width of the inline image. + * 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] */ - 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 `list.toJSON()`. */ - interface ListData { - /** - * Gets paragraphs in the list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - paragraphs?: Word.Interfaces.ParagraphData[]; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the list's id. + * Gets the index of the cell's row in the table. * * @remarks * [Api set: WordApi 1.3] */ - id?: number; + rowIndex?: number; /** - * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * 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] */ - levelExistences?: boolean[]; + shadingColor?: string; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Specifies the text of the cell. * * @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 { + value?: string; /** - * Specifies the level of the item in the list. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks * [Api set: WordApi 1.3] */ - level?: number; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Gets the list item bullet, number, or picture as a string. + * Gets the width of the cell in points. * * @remarks * [Api set: WordApi 1.3] */ - listString?: string; + 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 { /** - * Gets the list item order number in relation to its siblings. + * Specifies the table border color. * * @remarks * [Api set: WordApi 1.3] */ - siblingIndex?: number; - } - /** An interface describing the data returned by calling `listLevel.toJSON()`. */ - interface ListLevelData { + color?: string; /** - * Gets a Font object that represents the character formatting of the specified object. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontData; + 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 horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * 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] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + width?: number; + } + /** An interface describing the data returned by calling `template.toJSON()`. */ + interface TemplateData { /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: string; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Specifies the number format for the specified list level. + * Specifies the line break control level for the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: string; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Returns the name of the template, including the drive or Web path. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: number; + fullName?: string; /** - * Specifies the number style for the list level object. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + hasNoProofing?: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the character spacing adjustment for the template. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: number; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Specifies the starting number for the specified list level object. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: number; + kerningByAlgorithm?: boolean; /** - * Specifies the tab position for the specified list level object. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: number; + 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 position (in points) for the second line of wrapping text for the specified list level object. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: 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"; /** - * Specifies the character inserted after the number for the specified list level. + * Returns only the name of the document template (excluding any path or other location information). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + name?: string; /** - * Gets a ListLevels collection that represents all the levels for the specified ListTemplate. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listLevels?: Word.Interfaces.ListLevelData[]; + noLineBreakAfter?: string; /** - * Specifies whether the specified ListTemplate object is outline numbered. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineNumbered?: boolean; - } - /** An interface describing the data returned by calling `noteItem.toJSON()`. */ - interface NoteItemData { + noLineBreakBefore?: string; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Returns the path to the document template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + path?: string; /** - * Represents a footnote or endnote reference in the main 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reference?: Word.Interfaces.RangeData; + saved?: boolean; /** - * Represents the note item type: footnote or endnote. + * Returns the template type. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.NoteItemType | "Footnote" | "Endnote"; + type?: Word.TemplateType | "Normal" | "Global" | "Attached"; } - /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ - interface NoteItemCollectionData { - items?: Word.Interfaces.NoteItemData[]; + /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ + interface TemplateCollectionData { + items?: Word.Interfaces.TemplateData[]; } - /** An interface describing the data returned by calling `page.toJSON()`. */ - interface PageData { + /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ + interface TrackedChangeData { /** - * Gets a `BreakCollection` object that represents the breaks on the page. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - breaks?: Word.Interfaces.BreakData[]; + author?: string; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - height?: number; + date?: Date; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - index?: number; + text?: string; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Gets the type of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - width?: number; + type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; } - /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ - interface PageCollectionData { - items?: Word.Interfaces.PageData[]; + /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ + interface TrackedChangeCollectionData { + items?: Word.Interfaces.TrackedChangeData[]; } - /** An interface describing the data returned by calling `pane.toJSON()`. */ - interface PaneData { + /** An interface describing the data returned by calling `view.toJSON()`. */ + interface ViewData { /** - * Gets the collection of pages in the pane. + * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pages?: Word.Interfaces.PageData[]; + areAllNonprintingCharactersDisplayed?: 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. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + areBackgroundsDisplayed?: boolean; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + areBookmarksIndicated?: boolean; /** - * Gets the collection of fields in the paragraph. + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + areCommentsDisplayed?: boolean; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + areCropMarksDisplayed?: boolean; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItem?: Word.Interfaces.ListItemData; + areDrawingsDisplayed?: 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}. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItemOrNullObject?: Word.Interfaces.ListItemData; + areEditableRangesShaded?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Specifies whether field codes are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + areFieldCodesDisplayed?: 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. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + areFormatChangesDisplayed?: boolean; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areInkAnnotationsDisplayed?: 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 whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * Indicates the paragraph is the last one inside its parent body. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isLastParagraph?: boolean; + areLinesWrappedToWindow?: boolean; /** - * Checks whether the paragraph is a list item. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isListItem?: boolean; + areObjectAnchorsDisplayed?: boolean; /** - * Specifies the left indent value, in points, for the paragraph. + * Gets whether Microsoft Word displays optional line breaks. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + areOptionalBreaksDisplayed?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + areOptionalHyphensDisplayed?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + areOtherAuthorsVisible?: boolean; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + arePageBoundariesDisplayed?: boolean; /** - * Specifies the outline level for the paragraph. + * Gets whether paragraph marks are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: number; + areParagraphsMarksDisplayed?: boolean; /** - * Specifies the right indent value, in points, for the paragraph. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + arePicturePlaceholdersDisplayed?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + areRevisionsAndCommentsDisplayed?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * Gets whether space characters are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + areSpacesIndicated?: 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 whether table gridlines are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + areTableGridlinesDisplayed?: 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. + * Gets whether tab characters are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + areTabsDisplayed?: boolean; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableNestingLevel?: number; + areTextBoundariesDisplayed?: boolean; /** - * Gets the text of the paragraph. + * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * 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 on-screen shading for fields. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalId?: string; - } - /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ - interface ParagraphCollectionData { - items?: Word.Interfaces.ParagraphData[]; - } - /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ - interface ParagraphFormatData { + fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Specifies the alignment for the specified paragraphs. + * 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.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + isDraft?: 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 whether only the first line of body text is shown in outline view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + isFirstLineOnlyDisplayed?: boolean; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + isFormatDisplayed?: 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 window is in full-screen view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + isFullScreen?: boolean; /** - * Specifies the left indent. + * Gets whether text formatted as hidden text is displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + isHiddenTextDisplayed?: boolean; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Gets whether highlight formatting is displayed and printed with the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + isHighlightingDisplayed?: boolean; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + isInConflictMode?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + isInPanning?: boolean; /** - * Specifies whether left and right indents are the same width. + * Specifies whether the document is being viewed in reading layout view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + isInReadingLayout?: boolean; /** - * Specifies the outline level for the specified paragraphs. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + isMailMergeDataView?: boolean; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + isMainTextLayerVisible?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + isPointerShownAsMagnifier?: boolean; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + isReadingLayoutActualView?: 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. + * Specifies whether XML tags are visible in the document. * * @remarks - * [Api set: WordApi 1.5] - */ - widowControl?: boolean; - } - /** An interface describing the data returned by calling `range.toJSON()`. */ - interface RangeData { + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isXmlMarkupVisible?: boolean; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the range. + * Specifies the display mode for tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Gets the collection of field objects in the range. + * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies the page movement type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Gets a `FrameCollection` object that represents all the frames in the range. + * 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 */ - frames?: Word.Interfaces.FrameData[]; + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. + * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Gets the collection of inline picture objects in the range. + * Specifies the width of the revision balloons. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + revisionsBalloonWidth?: number; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listFormat?: Word.Interfaces.ListFormatData; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Gets the collection of pages in the range. + * Specifies the document element displayed in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pages?: Word.Interfaces.PageData[]; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Gets the collection of sections in the range. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sections?: Word.Interfaces.SectionData[]; + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + } + /** An interface describing the data returned by calling `shape.toJSON()`. */ + interface ShapeData { /** - * 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. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] */ - shapes?: Word.Interfaces.ShapeData[]; + body?: Word.Interfaces.BodyData; /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tableColumns?: Word.Interfaces.TableColumnData[]; + canvas?: Word.Interfaces.CanvasData; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hasNoProofing?: boolean; + fill?: Word.Interfaces.ShapeFillData; /** - * 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 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] */ - hyperlink?: string; + parentCanvas?: Word.Interfaces.ShapeData; /** - * Checks whether the range length is zero. + * 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] */ - isEmpty?: boolean; + parentGroup?: Word.Interfaces.ShapeData; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageDetected?: boolean; + shapeGroup?: Word.Interfaces.ShapeGroupData; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - 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"; + textFrame?: Word.Interfaces.TextFrameData; /** - * Specifies an East Asian language for the range. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - 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"; + textWrap?: Word.Interfaces.ShapeTextWrapData; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - 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"; + allowOverlap?: 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. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - style?: string; + altTextDescription?: 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. + * 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] */ - 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"; + 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"; /** - * Gets the text of the range. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - 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 { + height?: number; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - ignorePunct?: boolean; + heightRelative?: number; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Gets an integer that represents the shape identifier. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - ignoreSpace?: boolean; + id?: number; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Check whether this shape is a child of a group shape or a canvas shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchCase?: boolean; + isChild?: boolean; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - matchPrefix?: boolean; + left?: number; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - matchSuffix?: boolean; + leftRelative?: number; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchWholeWord?: boolean; + lockAspectRatio?: boolean; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * The name of the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchWildcards?: boolean; - } - /** An interface describing the data returned by calling `section.toJSON()`. */ - interface SectionData { + name?: string; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyData; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the 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}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - borders?: Word.Interfaces.BorderUniversalData[]; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Returns a `PageSetup` object that's associated with the section. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pageSetup?: Word.Interfaces.PageSetupData; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies if the section is protected for forms. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - 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 { + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the key of the setting. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - key?: string; + rotation?: number; /** - * Specifies the value of the setting. + * 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.4] + * [Api set: WordApiDesktop 1.2] */ - 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 { + top?: number; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * 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.1] + * [Api set: WordApiDesktop 1.2] */ - borders?: Word.Interfaces.BorderData[]; + topRelative?: number; /** - * Gets a font object that represents the character formatting of the specified style. + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontData; + type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frame?: Word.Interfaces.FrameData; + visible?: boolean; /** - * Specifies a link between a paragraph and a character style. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - linkStyle?: Word.Interfaces.StyleData; + width?: number; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * 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] */ - listTemplate?: Word.Interfaces.ListTemplateData; + widthRelative?: number; + } + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ + interface ShapeGroupData { /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatData; + shape?: Word.Interfaces.ShapeData; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - shading?: Word.Interfaces.ShadingData; + shapes?: Word.Interfaces.ShapeData[]; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Gets an integer that represents the shape group identifier. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - tableStyle?: Word.Interfaces.TableStyleData; + id?: number; + } + /** An interface describing the data returned by calling `canvas.toJSON()`. */ + interface CanvasData { /** - * Specifies whether the style is automatically redefined based on the selection. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - automaticallyUpdate?: boolean; + shape?: Word.Interfaces.ShapeData; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] + */ + shapes?: Word.Interfaces.ShapeData[]; + /** + * Gets an integer that represents the canvas identifier. * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - baseStyle?: string; + 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 { /** - * Gets whether the specified style is a built-in style. + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - builtIn?: boolean; + backgroundColor?: string; /** - * Gets the description of the specified style. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - description?: string; + foregroundColor?: string; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hasProofing?: boolean; + transparency?: number; /** - * Gets whether the specified 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. + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - inUse?: boolean; + type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + } + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ + interface TextFrameData { /** - * Specifies a `LanguageId` value that represents the language for the style. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - 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"; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Specifies an East Asian language for the style. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - 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"; + bottomMargin?: number; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Specifies if the text frame contains text. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - linked?: boolean; + hasText?: boolean; /** - * Returns the list level for the style. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - listLevelNumber?: number; + leftMargin?: number; /** - * Specifies whether the style cannot be changed or edited. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - locked?: boolean; + noTextRotation?: boolean; /** - * Gets the name of a style in the language of the user. + * Represents 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] */ - nameLocal?: string; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] + */ + rightMargin?: number; + /** + * Represents the top margin, in points, of the text frame. * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - nextParagraphStyle?: string; + topMargin?: number; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Specifies the priority. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - priority?: number; + wordWrap?: boolean; + } + /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ + interface ShapeTextWrapData { /** - * Specifies whether the style corresponds to an available quick style. + * 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] */ - quickStyle?: boolean; + bottomDistance?: number; /** - * Gets the style type. + * 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] */ - type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + leftDistance?: number; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * 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] */ - unhideWhenUsed?: boolean; + rightDistance?: number; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * 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] */ - visibility?: boolean; - } - /** An interface describing the data returned by calling `shading.toJSON()`. */ - interface ShadingData { + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * 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.6] + * [Api set: WordApiDesktop 1.2] */ - backgroundPatternColor?: string; + topDistance?: number; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - foregroundPatternColor?: string; + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + } + /** An interface describing the data returned by calling `reviewer.toJSON()`. */ + interface ReviewerData { /** - * 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 if the `Reviewer` object is visible. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + isVisible?: boolean; } - /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ - interface ShadingUniversalData { + /** 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 the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColor?: string; + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * 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 */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ + interface RepeatingSectionItemData { /** - * 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. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColor?: string; + range?: Word.Interfaces.RangeData; + } + /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ + interface DatePickerContentControlData { /** - * 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. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * 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 a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + range?: Word.Interfaces.RangeData; /** - * Gets the collection of field objects in the table. + * 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.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets all of the table rows. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rows?: Word.Interfaces.TableRowData[]; + color?: string; /** - * Gets the child tables nested one level deeper. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tables?: Word.Interfaces.TableData[]; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the format in which dates are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + dateDisplayFormat?: string; /** - * Specifies the number of header rows. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: number; + 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 the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Indicates whether all of the table rows are uniform. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isUniform?: boolean; + id?: string; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nestingLevel?: number; + isTemporary?: boolean; /** - * Gets the number of rows in the table. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowCount?: number; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + lockContentControl?: 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 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + lockContents?: boolean; /** - * Specifies whether the table has banded columns. + * Gets whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies whether the table has banded rows. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + tag?: string; /** - * 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 title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + title?: string; + } + /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ + interface PictureContentControlData { /** - * Specifies whether the table has a first column with a special style. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies whether the table has a last column with a special style. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleLastColumn?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies whether the table has a total (last) row with a special style. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + color?: string; /** - * Specifies the width of the table in points. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ - interface TableStyleData { + id?: string; /** - * Specifies the table's alignment against the page margin. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + isTemporary?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * 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.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: number; + lockContentControl?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * 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.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: number; + lockContents?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: number; + showingPlaceholderText?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightCellMargin?: number; + tag?: string; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin?: number; - } - /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ - interface TableCollectionData { - items?: Word.Interfaces.TableData[]; + title?: string; } - /** 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - borders?: Word.Interfaces.BorderUniversalData[]; - /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - shading?: Word.Interfaces.ShadingUniversalData; + /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ + interface GroupContentControlData { /** - * Returns the position of this column in a collection. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnIndex?: number; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirst?: boolean; + range?: Word.Interfaces.RangeData; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * 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 BETA (PREVIEW ONLY)] * @beta */ - isLast?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Returns the nesting level of the column. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestingLevel?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * 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 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 BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: number; + color?: string; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + id?: string; /** - * Specifies the width of the column, in points. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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[]; + isTemporary?: 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.FontData; + * 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 BETA (PREVIEW ONLY)] + * @beta + */ + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets the number of cells in the row. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellCount?: number; + lockContentControl?: boolean; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + lockContents?: boolean; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isHeader?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies the preferred height of the row in points. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - preferredHeight?: number; + tag?: string; /** - * Gets the index of the row in its parent table. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowIndex?: number; + title?: string; + } + /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ + interface BuildingBlockGalleryContentControlData { /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + range?: Word.Interfaces.RangeData; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets the body object of the cell. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets the index of the cell in its row. + * Specifies the category for the building block content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellIndex?: number; + buildingBlockCategory?: string; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth?: number; + 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 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + color?: string; /** - * Gets the index of the cell's row in the table. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowIndex?: number; + id?: string; /** - * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + isTemporary?: boolean; /** - * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + lockContentControl?: boolean; /** - * 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] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + lockContents?: boolean; /** - * Specifies the table border color. + * Gets if the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + tag?: string; /** - * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + title?: string; } - /** An interface describing the data returned by calling `template.toJSON()`. */ - interface TemplateData { + /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ + interface RepeatingSectionContentControlData { /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies the line break control level for the document. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + range?: Word.Interfaces.RangeData; /** - * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - fullName?: string; + xmlapping?: Word.Interfaces.XmlMappingData; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + allowInsertDeleteSection?: boolean; /** - * Specifies the character spacing adjustment for the template. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm?: boolean; + color?: string; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + id?: string; /** - * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + isTemporary?: boolean; /** - * Returns only the name of the document template (excluding any path or other location information). + * 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 BETA (PREVIEW ONLY)] * @beta */ - name?: string; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter?: string; + 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore?: string; + lockContents?: boolean; /** - * Returns the path to the document template. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - path?: string; + repeatingSectionItemTitle?: 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. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved?: boolean; + showingPlaceholderText?: boolean; /** - * Returns the template type. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + tag?: string; /** - * Gets the author of the tracked change. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: string; + title?: string; + } + /** An interface describing the data returned by calling `frame.toJSON()`. */ + interface FrameData { /** - * Gets the date of the tracked change. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - date?: Date; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Gets the text of the tracked change. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + range?: Word.Interfaces.RangeData; /** - * Gets the type of the tracked change. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + shading?: Word.Interfaces.ShadingUniversalData; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Specifies the height (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + height?: number; /** - * 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}. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - canvas?: Word.Interfaces.CanvasData; + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Returns the fill formatting of the shape. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fill?: Word.Interfaces.ShapeFillData; + horizontalDistanceFromText?: number; /** - * 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. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeData; + horizontalPosition?: number; /** - * 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. + * Specifies if the frame is locked. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeData; + lockAnchor?: boolean; /** - * 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}. + * Specifies the relative horizontal position of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupData; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the text frame object of the shape. + * Specifies the relative vertical position of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameData; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Returns the text wrap formatting of the shape. + * Specifies if document text wraps around the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapData; + textWrap?: boolean; /** - * Specifies whether a given shape can overlap other shapes. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + verticalDistanceFromText?: number; /** - * Specifies a string that represents the alternative text associated with the 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + verticalPosition?: number; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the width (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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"; + width?: number; /** - * The height, in points, of the shape. + * Specifies the rule used to determine the width of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + 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 { /** - * 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 any optional comments associated with this version of the shared document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heightRelative?: number; + comments?: string; /** - * Gets an integer that represents the shape identifier. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + modified?: any; /** - * Check whether this shape is a child of a group shape or a canvas 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChild?: 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 { /** - * 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 the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left?: number; + distanceFromText?: 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. + * Gets the name of the font for the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: number; + fontName?: string; /** - * Specifies if the aspect ratio of this shape is locked. + * Gets the height (in lines) of the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + linesToDrop?: number; /** - * The name of the shape. + * Gets the position of the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + position?: Word.DropPosition | "None" | "Normal" | "Margin"; + } + /** An interface describing the data returned by calling `listFormat.toJSON()`. */ + interface ListFormatData { /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + list?: Word.Interfaces.ListData; /** - * 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 list template associated with the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Indicates whether the `ListFormat` object contains a single list. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + isSingleList?: 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}. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + isSingleListTemplate?: boolean; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + listLevelNumber?: 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. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: number; + listString?: string; /** - * 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. + * Gets the type of the list for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + listValue?: number; + } + /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ + interface FillFormatData { /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + backgroundColor?: Word.Interfaces.ColorFormatData; /** - * The width, in points, of the shape. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * 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 angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative?: number; - } - /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ - interface ShapeGroupData { + gradientAngle?: number; /** - * Gets the Shape object associated with the group. + * Gets the gradient color type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * 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.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + gradientDegree?: number; /** - * Gets an integer that represents the shape group identifier. + * Returns the gradient style for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; - } - /** An interface describing the data returned by calling `canvas.toJSON()`. */ - interface CanvasData { + gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * Gets the Shape object associated with the canvas. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + gradientVariant?: number; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + isVisible?: boolean; /** - * Gets an integer that represents the canvas identifier. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + 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 shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Returns the preset gradient type for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + 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 shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the preset texture. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: string; + 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 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. + * Specifies whether the fill rotates with the shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency?: number; + rotateWithObject?: boolean; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; - } - /** An interface describing the data returned by calling `textFrame.toJSON()`. */ - interface TextFrameData { + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * 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 horizontal scaling factor for the texture fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + textureHorizontalScale?: number; /** - * Represents the bottom margin, in points, of the text frame. + * Returns the name of the custom texture file for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + textureName?: string; /** - * Specifies if the text frame contains text. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hasText?: boolean; + textureOffsetX?: number; /** - * Represents the left margin, in points, of the text frame. + * Specifies the vertical offset of the texture. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + textureOffsetY?: number; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies whether the texture is tiled. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + textureTile?: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Returns the texture type for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Represents the right margin, in points, of the text frame. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: number; + textureVerticalScale?: number; /** - * Represents the top margin, in points, of the text frame. + * 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.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin?: number; + transparency?: number; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Gets the fill format type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + } + /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ + interface GlowFormatData { /** - * Determines whether lines break automatically to fit text inside the shape. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap?: boolean; - } - /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ - interface ShapeTextWrapData { + color?: Word.Interfaces.ColorFormatData; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Specifies the length of the radius for a glow effect. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: number; + radius?: 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 degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + transparency?: number; + } + /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ + interface LineFormatData { /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + backgroundColor?: Word.Interfaces.ColorFormatData; /** - * 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 a `ColorFormat` object that represents the foreground color for the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: number; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - placeholderText?: Word.Interfaces.BuildingBlockData; - /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - xmlMapping?: Word.Interfaces.XmlMappingData; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies the appearance of the content control. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * 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 dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the format in which dates are displayed. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: string; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * 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 to draw lines inside a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + insetPen?: boolean; /** - * Gets the identification for the content control. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + isVisible?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: 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 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 line format style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * 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 degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + transparency?: 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 thickness of the line in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + weight?: number; + } + /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ + interface ReflectionFormatData { /** - * Gets whether the placeholder text for the content control is being displayed. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + blur?: number; /** - * Specifies a tag to identify the content control. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + offset?: number; /** - * Specifies the title for the content control. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - placeholderText?: Word.Interfaces.BuildingBlockData; - /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - xmlMapping?: Word.Interfaces.XmlMappingData; + size?: number; /** - * Specifies the appearance of 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + transparency?: number; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + 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 { /** - * Returns the identification for the content control. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + brightness?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * 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 red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + rgb?: string; /** - * 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 lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + tintAndShade?: 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. + * Returns the shape color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + type?: Word.ColorType | "rgb" | "scheme"; + } + /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ + interface ShadowFormatData { /** - * Returns whether the placeholder text for the content control is being displayed. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Specifies a tag to identify the content control. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + blur?: number; /** - * Specifies the title for the content control. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - placeholderText?: Word.Interfaces.BuildingBlockData; - /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - xmlMapping?: Word.Interfaces.XmlMappingData; + isVisible?: boolean; /** - * Specifies the appearance of the content 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + obscured?: 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 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + offsetX?: number; /** - * Returns the identification for the content control. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + offsetY?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + rotateWithShape?: 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 width of the shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + size?: 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 type of shadow formatting to apply to a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * 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 degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + transparency?: number; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + 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 `threeDimensionalFormat.toJSON()`. */ + interface ThreeDimensionalFormatData { /** - * Specifies a tag to identify the content control. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + contourColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the title for the content control. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - placeholderText?: Word.Interfaces.BuildingBlockData; - /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - xmlMapping?: Word.Interfaces.XmlMappingData; + extrusionColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the appearance of the content control. + * Specifies the depth of the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + bevelBottomDepth?: number; /** - * Specifies the category for the building block content control. + * Specifies the inset size for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: string; + bevelBottomInset?: number; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * 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 depth of the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + bevelTopDepth?: number; /** - * Gets the identification for the content control. + * Specifies the inset size for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + bevelTopInset?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * 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 width of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + contourWidth?: 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 depth of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + depth?: 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 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Gets if the placeholder text for the content control is being displayed. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + fieldOfView?: number; /** - * Specifies a tag to identify the content control. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + isPerspective?: boolean; /** - * Specifies the title for the content control. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - placeholderText?: Word.Interfaces.BuildingBlockData; - /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - xmlapping?: Word.Interfaces.XmlMappingData; + isVisible?: boolean; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Specifies the angle of the lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + lightAngle?: number; /** - * Specifies the appearance of the content control. + * Returns a `PresetCamera` value that represents the camera presets. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + 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 the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Returns the identification for the content control. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + 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 whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * 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 intensity of the extrusion lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * 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 extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * 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. + * Returns the preset extrusion format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + 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 the name of the repeating section items used in the context menu associated with this repeating section content control. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: string; + projectText?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + rotationX?: number; /** - * Specifies a tag to identify the content control. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + rotationY?: number; /** - * Specifies the title for the content control. + * Specifies the z-axis rotation of the camera. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - borders?: Word.Interfaces.BorderUniversalData[]; - /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - range?: Word.Interfaces.RangeData; - /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - shading?: Word.Interfaces.ShadingUniversalData; + rotationZ?: number; /** - * Specifies the height (in points) of the frame. + * Specifies the position on the z-axis for the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + z?: number; + } + /** An interface describing the data returned by calling `bibliography.toJSON()`. */ + interface BibliographyData { /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + sources?: Word.Interfaces.SourceData[]; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the name of the active style to use for the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: number; + 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 { /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: number; + isCited?: boolean; /** - * Specifies if the frame is locked. + * Gets the tag of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + tag?: string; /** - * Specifies the relative horizontal position of the frame. + * Gets the XML representation of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + xml?: string; + } + /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ + interface PageSetupData { /** - * Specifies the relative vertical position of the frame. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + lineNumbering?: Word.Interfaces.LineNumberingData; /** - * Specifies if document text wraps around the frame. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + textColumns?: Word.Interfaces.TextColumnData[]; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalDistanceFromText?: number; + bookFoldPrinting?: boolean; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies the number of pages for each booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: number; + bookFoldPrintingSheets?: number; /** - * Specifies the width (in points) of the frame. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + bookFoldReversePrinting?: boolean; /** - * Specifies the rule used to determine the width of the frame. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + bottomMargin?: number; /** - * Gets any optional comments associated with this version of the shared document. + * Specifies the number of characters per line in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments?: string; + charsLine?: number; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies whether the first page has a different header and footer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modified?: any; + differentFirstPageHeaderFooter?: boolean; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list?: Word.Interfaces.ListData; - /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - listTemplate?: Word.Interfaces.ListTemplateData; + footerDistance?: number; /** - * Indicates whether the `ListFormat` object contains a single list. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleList?: boolean; + gutter?: number; /** - * Indicates whether the `ListFormat` object contains a single list template. + * Specifies on which side the gutter appears in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleListTemplate?: boolean; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * 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 BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * Specifies the distance between the header and the top of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listString?: string; + headerDistance?: number; /** - * Gets the type of the list for the `ListFormat` object. + * Specifies the layout mode for the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listValue?: number; - } - /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ - interface FillFormatData { - /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - backgroundColor?: Word.Interfaces.ColorFormatData; - /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - foregroundColor?: Word.Interfaces.ColorFormatData; + leftMargin?: number; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: number; + linesPage?: number; /** - * Gets the gradient color type. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + mirrorMargins?: 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 whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientDegree?: number; + oddAndEvenPagesHeaderFooter?: boolean; /** - * Returns the gradient style for the fill. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * Specifies the page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientVariant?: number; + pageHeight?: number; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + pageWidth?: number; /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + 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"; /** - * Returns the preset gradient type for the fill. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + rightMargin?: number; /** - * Gets the preset texture. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies whether the fill rotates with the shape. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + showGrid?: boolean; /** - * Specifies the horizontal scaling factor for the texture fill. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale?: number; + suppressEndnotes?: boolean; /** - * Returns the name of the custom texture file for the fill. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureName?: string; + topMargin?: number; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX?: number; + twoPagesOnOne?: boolean; /** - * Specifies the vertical offset of the texture. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY?: number; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + } + /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ + interface LineNumberingData { /** - * Specifies whether the texture is tiled. + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + countBy?: number; /** - * Returns the texture type for the fill. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + distanceFromText?: number; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale?: number; + isActive?: 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 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Gets the fill format type. + * Specifies the starting line number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + startingNumber?: number; } - /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ - interface GlowFormatData { - /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - color?: Word.Interfaces.ColorFormatData; + /** 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 { /** - * Specifies the length of the radius for a glow effect. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius?: number; + spaceAfter?: number; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + width?: number; } - /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ - interface LineFormatData { - /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - backgroundColor?: Word.Interfaces.ColorFormatData; - /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - foregroundColor?: Word.Interfaces.ColorFormatData; + /** An interface describing the data returned by calling `bookmark.toJSON()`. */ + interface BookmarkData { /** - * Specifies the length of the arrowhead at the beginning of the line. + * 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 */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + range?: Word.Interfaces.RangeData; /** - * Specifies the style of the arrowhead at the beginning of the line. + * Specifies the ending character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + end?: number; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Returns `true` if the bookmark is a table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + isColumn?: boolean; /** - * Specifies the dash style for the line. + * Returns `true` if the bookmark is empty. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + isEmpty?: boolean; /** - * Specifies the length of the arrowhead at the end of the line. + * Returns the name of the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + name?: string; /** - * Specifies the style of the arrowhead at the end of the line. + * Specifies the starting character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + start?: number; /** - * Specifies the width of the arrowhead at the end of the line. + * Returns the story type for the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + 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 `bookmarkCollection.toJSON()`. */ + interface BookmarkCollectionData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface describing the data returned by calling `index.toJSON()`. */ + interface IndexData { /** - * Specifies if to draw lines inside a shape. + * 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 */ - insetPen?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies if the object, or the formatting applied to it, is visible. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; /** - * Specifies the pattern applied to the line. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; /** - * Specifies the line format style. + * Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + 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 degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the number of columns for each page of the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + numberOfColumns?: number; /** - * Specifies the thickness of the line in points. + * Specifies if page numbers are aligned with the right margin in the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight?: number; - } - /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ - interface ReflectionFormatData { + rightAlignPageNumbers?: boolean; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + separateAccentedLetterHeadings?: boolean; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Specifies the sorting criteria for the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset?: number; + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the index type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + type?: Word.IndexType | "Indent" | "Runin"; + } + /** An interface describing the data returned by calling `indexCollection.toJSON()`. */ + interface IndexCollectionData { + items?: Word.Interfaces.IndexData[]; + } + /** + * Represents an annotation wrapper around critique displayed in the document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface CritiqueAnnotationLoadOptions { /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - 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 { + $all?: boolean; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Gets the range of text that is annotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - brightness?: number; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the theme color for a color format. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + critique?: boolean; + } + /** + * Represents an annotation attached to a paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface AnnotationLoadOptions { /** - * Specifies the red-green-blue (RGB) value of the specified color. 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 critique annotation object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - rgb?: string; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * 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 unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - tintAndShade?: number; + id?: boolean; /** - * Returns the shape color type. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - type?: Word.ColorType | "rgb" | "scheme"; + state?: boolean; } - /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ - interface ShadowFormatData { + /** + * Contains a collection of {@link Word.Annotation} objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface AnnotationCollectionLoadOptions { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - 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. + * For EACH ITEM in the collection: Gets the critique annotation object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - blur?: number; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Specifies whether the object or the formatting applied to it is visible. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - isVisible?: boolean; + id?: 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. + * For EACH ITEM in the collection: Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - obscured?: boolean; + state?: boolean; + } + /** + * Represents the application object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ApplicationLoadOptions { /** - * 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. + 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 `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX?: number; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * 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 if Microsoft Word automatically detects the language you are using as you type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: number; + checkLanguage?: boolean; /** - * Specifies whether to rotate the shadow when rotating the shape. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + language?: boolean; + } + /** + * Represents the body of a document or a section. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface BodyLoadOptions { /** - * Specifies the width of the shadow. + 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - size?: number; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the type of shadow formatting to apply to a shape. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - transparency?: number; + parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the shape shadow type. + * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - 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 `threeDimensionalFormat.toJSON()`. */ - interface ThreeDimensionalFormatData { - /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - contourColor?: Word.Interfaces.ColorFormatData; - /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - extrusionColor?: Word.Interfaces.ColorFormatData; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the depth of the bottom bevel. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bevelBottomDepth?: number; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the inset size for the bottom bevel. + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bevelBottomInset?: number; + parentSection?: Word.Interfaces.SectionLoadOptions; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; /** - * Specifies the depth of the top bevel. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - bevelTopDepth?: number; + style?: boolean; /** - * Specifies the inset size for the top bevel. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bevelTopInset?: number; + styleBuiltIn?: boolean; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * Gets the text of the body. Use the insertText method to insert text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + text?: boolean; /** - * Specifies the width of the contour of a shape. + * 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 WordApiOnline 1.1 and later. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - contourWidth?: number; + type?: boolean; + } + /** + * Represents the Border object for text, a paragraph, or a table. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface BorderLoadOptions { /** - * Specifies the depth of the shape's extrusion. + 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - depth?: number; + color?: 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. + * Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + location?: boolean; /** - * Specifies the amount of perspective for a shape. + * Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - fieldOfView?: number; + type?: 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. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isPerspective?: boolean; + visible?: boolean; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isVisible?: boolean; + width?: boolean; + } + /** + * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BorderUniversalLoadOptions { /** - * Specifies the angle of the lighting. + 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 graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: number; + artStyle?: boolean; /** - * Returns a `PresetCamera` value that represents the camera presets. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + artWidth?: boolean; /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + color?: boolean; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + colorIndex?: boolean; /** - * Specifies the position of the light source relative to the extrusion. + * Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + inside?: boolean; /** - * Specifies the intensity of the extrusion lighting. + * Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + isVisible?: boolean; /** - * Specifies the extrusion surface material. + * Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + lineStyle?: boolean; /** - * Returns the preset extrusion format. + * Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + lineWidth?: boolean; + } + /** + * Represents the collection of border styles. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface BorderCollectionLoadOptions { /** - * Specifies whether text on a shape rotates with shape. `true` rotates the 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: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - projectText?: boolean; + color?: boolean; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * For EACH ITEM in the collection: Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - rotationX?: number; + location?: boolean; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * For EACH ITEM in the collection: Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - rotationY?: number; + type?: boolean; /** - * Specifies the z-axis rotation of the camera. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - rotationZ?: number; + visible?: boolean; /** - * Specifies the position on the z-axis for the shape. + * For EACH ITEM in the collection: Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - z?: number; + width?: boolean; } - /** An interface describing the data returned by calling `bibliography.toJSON()`. */ - interface BibliographyData { + /** + * Represents the collection of {@link Word.BorderUniversal} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BorderUniversalCollectionLoadOptions { /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - sources?: Word.Interfaces.SourceData[]; + 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 name of the active style to use for the bibliography. + * For EACH ITEM in the collection: Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + artStyle?: boolean; /** - * Gets if the `Source` object has been cited in the document. + * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isCited?: boolean; + artWidth?: boolean; /** - * Gets the tag of the source. + * 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 BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + color?: boolean; /** - * Gets the XML representation of the source. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; - } - /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ - interface PageSetupData { - /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - lineNumbering?: Word.Interfaces.LineNumberingData; - /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textColumns?: Word.Interfaces.TextColumnData[]; + colorIndex?: boolean; /** - * Specifies whether Microsoft Word prints the document as a booklet. + * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrinting?: boolean; + inside?: boolean; /** - * Specifies the number of pages for each booklet. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrintingSheets?: number; + isVisible?: boolean; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * For EACH ITEM in the collection: Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting?: boolean; + lineStyle?: boolean; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * For EACH ITEM in the collection: Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomMargin?: number; + lineWidth?: boolean; + } + /** + * Represents a break in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BreakLoadOptions { /** - * Specifies the number of characters per line in the document grid. + 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. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine?: number; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies whether the first page has a different header and footer. + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter?: boolean; + pageIndex?: boolean; + } + /** + * Contains a collection of {@link Word.Break} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BreakCollectionLoadOptions { /** - * Specifies the distance between the footer and the bottom of the page 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; + /** + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance?: number; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * For EACH ITEM in the collection: Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter?: number; + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockLoadOptions { /** - * Specifies on which side the gutter appears in a 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; + /** + * Returns a `BuildingBlockCategory` object that represents the category for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * Specifies the distance between the header and the top of the page in points. + * Specifies the description for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance?: number; + description?: boolean; /** - * Specifies the layout mode for the current document. + * Returns the internal identification number for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + id?: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * Returns the position of this building block in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftMargin?: number; + index?: boolean; /** - * Specifies the number of lines per page in the document grid. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesPage?: number; + insertType?: boolean; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Specifies the name of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mirrorMargins?: boolean; + name?: boolean; /** - * Specifies whether odd and even pages have different headers and footers. + * Specifies the contents of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddAndEvenPagesHeaderFooter?: boolean; + value?: boolean; + } + /** + * Represents a category of building blocks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockCategoryLoadOptions { /** - * Specifies the orientation of the page. + 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * Specifies the page height in points. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageHeight?: number; + index?: boolean; /** - * Specifies the page width in points. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageWidth?: number; + name?: boolean; + } + /** + * Represents a type of building block in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockTypeItemLoadOptions { /** - * Specifies the paper size of the page. + 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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"; + index?: boolean; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Returns the localized name of a building block type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightMargin?: number; + name?: boolean; + } + /** + * The data specific to content controls of type CheckBox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface CheckboxContentControlLoadOptions { /** - * Specifies the reading order and alignment for the specified sections. + 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + isChecked?: boolean; + } + /** + * Represents a comment in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentLoadOptions { /** - * Specifies the type of section break for the specified 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 comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies whether to show the grid. + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - showGrid?: boolean; + authorEmail?: boolean; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Gets the name of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - suppressEndnotes?: boolean; + authorName?: boolean; /** - * Specifies the top margin of the page in points. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - topMargin?: number; + content?: boolean; /** - * Specifies whether to print two pages per sheet. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - twoPagesOnOne?: boolean; + creationDate?: boolean; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + id?: 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; } - /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ - interface LineNumberingData { + /** + * Contains a collection of {@link Word.Comment} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentCollectionLoadOptions { /** - * Specifies the numeric increment for line numbers. + 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 comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - countBy?: number; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * 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 email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - distanceFromText?: number; + authorEmail?: boolean; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * For EACH ITEM in the collection: Gets the name of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isActive?: boolean; + authorName?: 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: Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + content?: boolean; /** - * Specifies the starting line number. + * For EACH ITEM in the collection: Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 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 { + creationDate?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Gets the ID of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - spaceAfter?: number; + id?: boolean; /** - * Specifies the width, in points, of the specified text columns. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - width?: number; + resolved?: boolean; } /** - * Represents an annotation wrapper around critique displayed in the document. - * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - interface CritiqueAnnotationLoadOptions { + interface CommentContentRangeLoadOptions { /** 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. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - range?: Word.Interfaces.RangeLoadOptions; + bold?: boolean; /** - * Gets the critique that was passed when the annotation was inserted. + * 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.7] + * [Api set: WordApi 1.4] */ - critique?: boolean; - } - /** - * Represents an annotation attached to a paragraph. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface AnnotationLoadOptions { + 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`). + * Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.4] */ - $all?: boolean; + isEmpty?: boolean; /** - * Gets the critique annotation object. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + italic?: boolean; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - id?: boolean; + strikeThrough?: boolean; /** - * Gets the state of the annotation. + * Gets the text of the comment range. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - state?: boolean; + 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; } /** - * Contains a collection of {@link Word.Annotation} objects. + * Represents a comment reply in the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - interface AnnotationCollectionLoadOptions { + interface CommentReplyLoadOptions { /** 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 critique annotation object. + * Specifies the commentReply's content range. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Gets the parent comment of this reply. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - id?: boolean; + parentComment?: Word.Interfaces.CommentLoadOptions; /** - * For EACH ITEM in the collection: Gets the state of the annotation. + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - state?: boolean; - } - /** - * Represents the application object. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ApplicationLoadOptions { + authorEmail?: 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 name of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] */ - $all?: boolean; + authorName?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + content?: boolean; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - checkLanguage?: boolean; + creationDate?: boolean; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - language?: boolean; + id?: boolean; } /** - * Represents the body of a document or a section. + * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - interface BodyLoadOptions { + interface CommentReplyCollectionLoadOptions { /** 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. + * For EACH ITEM in the collection: Specifies the commentReply's content range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - font?: Word.Interfaces.FontLoadOptions; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Gets the parent comment of this reply. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + parentComment?: Word.Interfaces.CommentLoadOptions; /** - * 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}. + * For EACH ITEM in the collection: Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + */ + authorEmail?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorName?: boolean; + /** + * 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; + /** + * For EACH ITEM in the collection: Gets the creation date of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: boolean; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface XmlMappingLoadOptions { + /** + 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`). */ - parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; + $all?: boolean; /** - * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * 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: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * 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}. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentSection?: Word.Interfaces.SectionLoadOptions; + isMapped?: boolean; /** - * 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}. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; + prefixMappings?: boolean; /** - * 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. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + xpath?: boolean; + } + /** + * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlPrefixMappingCollectionLoadOptions { /** - * 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] + 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`). */ - styleBuiltIn?: boolean; + $all?: boolean; /** - * Gets the text of the body. Use the insertText method to insert text. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + namespaceUri?: boolean; /** - * 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 WordApiOnline 1.1 and later. + * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + prefix?: boolean; } /** - * Represents the Border object for text, a paragraph, or a table. + * Represents a `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface BorderLoadOptions { + interface CustomXmlPrefixMappingLoadOptions { /** 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. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: boolean; + namespaceUri?: boolean; /** - * Gets the location of the border. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - location?: boolean; + prefix?: boolean; + } + /** + * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlSchemaLoadOptions { /** - * Specifies the border type for the border. - * - * @remarks - * [Api set: WordApiDesktop 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`). */ - type?: boolean; + $all?: boolean; /** - * Specifies whether the border is visible. + * Gets the location of the schema on a computer. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + location?: boolean; /** - * Specifies the width for the border. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; + namespaceUri?: boolean; } /** - * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BorderUniversalLoadOptions { + interface CustomXmlSchemaCollectionLoadOptions { /** 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 graphical page-border design for the document. + * For EACH ITEM in the collection: Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: boolean; + location?: boolean; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: boolean; + namespaceUri?: boolean; + } + /** + * Represents a collection of {@link Word.CustomXmlValidationError} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlValidationErrorCollectionLoadOptions { /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - color?: boolean; + $all?: boolean; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * For EACH ITEM in the collection: Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: boolean; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns `true` if an inside border can be applied to the specified object. + * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + errorCode?: boolean; /** - * Specifies whether the border is visible. + * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + name?: boolean; /** - * Specifies the line style of the border. + * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: boolean; + text?: boolean; /** - * Specifies the line width of an object's border. + * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: boolean; + type?: boolean; } /** - * Represents the collection of border styles. + * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface BorderCollectionLoadOptions { + interface CustomXmlValidationErrorLoadOptions { /** 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. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: boolean; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the location of the border. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - location?: boolean; + errorCode?: boolean; /** - * For EACH ITEM in the collection: Specifies the border type for the border. + * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + name?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * Gets the text in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Specifies the width for the border. + * Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; + type?: boolean; } /** - * Represents the collection of {@link Word.BorderUniversal} objects. + * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BorderUniversalCollectionLoadOptions { + 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: Specifies the graphical page-border design for the document. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: boolean; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * 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: 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: boolean; + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * 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 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * 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 object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: boolean; + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * 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 parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the line style of the border. + * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: boolean; + baseName?: boolean; /** - * For EACH ITEM in the collection: Specifies the line width of an object's border. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: boolean; - } - /** - * Represents a break in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BreakLoadOptions { + namespaceUri?: 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 type of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nodeType?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * For EACH ITEM in the collection: Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + nodeValue?: boolean; /** - * Returns the page number on which the break occurs. + * For EACH ITEM in the collection: Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: boolean; + text?: 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xpath?: boolean; + /** + * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xml?: boolean; } /** - * Contains a collection of {@link Word.Break} objects. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BreakCollectionLoadOptions { + interface CustomXmlNodeLoadOptions { /** 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 in the break. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Returns the page number on which the break occurs. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BuildingBlockLoadOptions { + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - 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 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Returns a `BuildingBlockCategory` object that represents the category for the building block. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the description for the building block. + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: boolean; + baseName?: boolean; /** - * Returns the internal identification number for the building block. + * Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + namespaceUri?: boolean; /** - * Returns the position of this building block in a collection. + * Gets the type of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + nodeType?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: boolean; + nodeValue?: boolean; /** - * Specifies the name of the building block. + * Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + text?: boolean; /** - * Specifies the contents of the building block. + * 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 BETA (PREVIEW ONLY)] * @beta */ - value?: boolean; + xpath?: boolean; + /** + * Gets the XML representation of the current node and its children. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xml?: boolean; } /** - * Represents a category of building blocks in a Word document. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - interface BuildingBlockCategoryLoadOptions { + interface ContentControlLoadOptions { /** 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; - /** - * Returns the position of the `BuildingBlockCategory` object in a 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 BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Returns the name of the `BuildingBlockCategory` object. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; - } - /** - * Represents a type of building block in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BuildingBlockTypeItemLoadOptions { + datePickerContentControl?: Word.Interfaces.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`). + * 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] */ - $all?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Returns the position of an item in a collection. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Returns the localized name of a building block type. + * Gets the parent body of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: boolean; - } - /** - * The data specific to content controls of type CheckBox. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface CheckboxContentControlLoadOptions { + parentBody?: Word.Interfaces.BodyLoadOptions; /** - 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 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] */ - $all?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the current state of the checkbox. + * 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.7] + * [Api set: WordApi 1.3] */ - isChecked?: boolean; - } - /** - * Represents a comment in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentLoadOptions { + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - 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 table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies the comment's content 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the email of the comment's author. + * 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.4] + * [Api set: WordApi 1.3] */ - authorEmail?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the name of the comment's author. + * 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.4] + * [Api set: WordApi 1.3] */ - authorName?: boolean; + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + appearance?: boolean; + /** + * 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 the comment's content as plain text. + * Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + cannotEdit?: boolean; /** - * Gets the creation date of the comment. + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - creationDate?: boolean; + color?: boolean; /** - * Gets the ID of the comment. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ id?: 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 placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @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 { + placeholderText?: 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 a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + removeWhenEdited?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment's content range. + * 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.4] + * [Api set: WordApi 1.1] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + style?: boolean; /** - * For EACH ITEM in the collection: Gets the email of the comment's author. + * 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.4] + * [Api set: WordApi 1.3] */ - authorEmail?: boolean; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the comment's author. + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorName?: boolean; + subtype?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment's content as plain text. + * Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + tag?: boolean; /** - * For EACH ITEM in the collection: Gets the creation date of the comment. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - creationDate?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the comment. + * Specifies the title for a content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: boolean; + title?: 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. + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - resolved?: boolean; + 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.4] + * [Api set: WordApi 1.1] */ - interface CommentContentRangeLoadOptions { + interface ContentControlCollectionLoadOptions { /** 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. + * 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.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * 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. + * 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.4] + * [Api set: WordApi 1.7] */ - hyperlink?: boolean; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Checks whether the range length is zero. + * 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: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isEmpty?: boolean; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Specifies a value that indicates whether the comment text is italicized. + * 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.4] + * [Api set: WordApi 1.1] */ - italic?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * 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: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Gets the text of the comment range. + * For EACH ITEM in the collection: Gets the parent body of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - text?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * 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.4] - */ - underline?: boolean; - } - /** - * Represents a comment reply in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentReplyLoadOptions { - /** - 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.1] */ - $all?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the commentReply's content range. + * 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.4] + * [Api set: WordApi 1.3] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the parent comment of this reply. + * 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.4] + * [Api set: WordApi 1.3] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the email of the comment reply's author. + * 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.4] + * [Api set: WordApi 1.3] */ - authorEmail?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the name of the comment reply's author. + * 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.4] + * [Api set: WordApi 1.3] */ - authorName?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the comment reply's content. The string is plain text. + * 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.4] + * [Api set: WordApi 1.3] */ - content?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the creation date of the comment reply. + * 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.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * Gets the ID of the comment reply. + * 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.4] - */ - 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 { - /** - 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 BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the commentReply's content range. + * 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.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent comment of this reply. + * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + appearance?: boolean; /** - * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * 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.4] + * [Api set: WordApi 1.1] */ - authorEmail?: boolean; + cannotDelete?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the comment reply's author. + * 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.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + cannotEdit?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. + * 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: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + color?: boolean; /** - * For EACH ITEM in the collection: Gets the creation date of the comment reply. + * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - creationDate?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the comment reply. + * 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: 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface XmlMappingLoadOptions { - /** - 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.1] */ - $all?: boolean; + placeholderText?: boolean; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + removeWhenEdited?: boolean; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; + style?: boolean; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMapped?: boolean; + styleBuiltIn?: boolean; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * 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, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - prefixMappings?: boolean; + subtype?: boolean; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * For EACH ITEM in the collection: Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xpath?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlPrefixMappingCollectionLoadOptions { + tag?: 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 text of the content control. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Specifies the title for a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; + title?: boolean; /** - * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - prefix?: boolean; + type?: boolean; } /** - * Represents a `CustomXmlPrefixMapping` object. + * Represents a list item in a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - interface CustomXmlPrefixMappingLoadOptions { + interface ContentControlListItemLoadOptions { /** 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 BETA (PREVIEW ONLY)] - * @beta - */ - namespaceUri?: boolean; - /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - prefix?: boolean; - } - /** - * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlSchemaLoadOptions { - /** - 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.9] */ - $all?: boolean; + displayText?: boolean; /** - * Gets the location of the schema on a computer. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - location?: boolean; + index?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - namespaceUri?: boolean; + value?: boolean; } /** - * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - interface CustomXmlSchemaCollectionLoadOptions { + interface ContentControlListItemCollectionLoadOptions { /** 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. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - location?: boolean; + displayText?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - namespaceUri?: boolean; + index?: boolean; + /** + * 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: WordApi 1.9] + */ + value?: boolean; } /** - * Represents a collection of {@link Word.CustomXmlValidationError} objects. + * Represents a custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - interface CustomXmlValidationErrorCollectionLoadOptions { + interface CustomPropertyLoadOptions { /** 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 node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - errorCode?: boolean; - /** - * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: boolean; + key?: boolean; /** - * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - text?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - type?: boolean; + value?: boolean; } /** - * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. + * Contains the collection of {@link Word.CustomProperty} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - interface CustomXmlValidationErrorLoadOptions { + 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`). */ $all?: boolean; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - errorCode?: boolean; - /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * For EACH ITEM in the collection: Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: boolean; + key?: boolean; /** - * Gets the text in the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - text?: boolean; + type?: boolean; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - type?: boolean; + value?: boolean; } /** - * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. + * Represents a custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - interface CustomXmlNodeCollectionLoadOptions { + 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`). */ $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`. + * 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 BETA (PREVIEW ONLY)] * @beta */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + documentElement?: 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`. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + builtIn?: boolean; + /** + * Gets the ID of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; + /** + * Gets the namespace URI of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + namespaceUri?: boolean; /** - * 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`. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + xml?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CustomXmlPartCollectionLoadOptions { /** - * For EACH ITEM in the collection: Gets the object representing the part associated with this node. + 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * 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`. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + builtIn?: 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`. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + id?: boolean; /** - * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - baseName?: boolean; + namespaceUri?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + xml?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CustomXmlPartScopedCollectionLoadOptions { /** - * For EACH ITEM in the collection: Gets the type of the current node. + 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: boolean; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the value of the current node. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Specifies the text for the current node. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - text?: boolean; + id?: 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. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - xpath?: boolean; + namespaceUri?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -142230,2603 +150163,2507 @@ declare namespace Word { xml?: boolean; } /** - * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - interface CustomXmlNodeLoadOptions { + interface DocumentLoadOptions { /** 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 `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 active window for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + activeWindow?: Word.Interfaces.WindowLoadOptions; /** - * 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`. + * Specifies a `Template` object that represents the template attached to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + attachedTemplate?: Word.Interfaces.TemplateLoadOptions; /** - * 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`. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Gets the object representing the part associated with this node. + * 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; + /** + * Returns a `PageSetup` object that's associated with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: boolean; + autoHyphenation?: boolean; /** - * Gets the unique address identifier for the namespace of the node. + * Specifies if the edits in the document are automatically saved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + autoSaveOn?: boolean; /** - * Gets the type of the current node. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - nodeType?: boolean; + changeTrackingMode?: boolean; /** - * Specifies the value of the current node. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + consecutiveHyphensLimit?: boolean; /** - * Specifies the text for the current node. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: boolean; + hyphenateCaps?: 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. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xpath?: boolean; + languageDetected?: boolean; /** - * Gets the XML representation of the current node and its children. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xml?: boolean; + saved?: 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. + * 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.1] + * [Api set: WordApi 1.3] */ - interface ContentControlLoadOptions { + 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`). */ $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 BETA (PREVIEW ONLY)] - * @beta - */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; - /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiHiddenDocument 1.3] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * 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] */ - font?: Word.Interfaces.FontLoadOptions; + saved?: boolean; + } + /** + * Represents document properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface DocumentPropertiesLoadOptions { /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; + $all?: boolean; /** - * Gets the parent body of the content control. + * Gets the application name of the document. * * @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. - * - * @remarks - * [Api set: WordApi 1.1] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + applicationName?: boolean; /** - * 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}. + * Specifies the author of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + author?: boolean; /** - * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * Specifies the category of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentTable?: Word.Interfaces.TableLoadOptions; + category?: boolean; /** - * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * 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] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + comments?: boolean; /** - * 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}. + * Specifies the company of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + company?: boolean; /** - * 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}. + * Gets the creation date of the document. * * @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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + creationDate?: boolean; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies the format of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + format?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the keywords of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + keywords?: boolean; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Gets the last author of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - appearance?: boolean; + lastAuthor?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Gets the last print date of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - cannotDelete?: boolean; + lastPrintDate?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Gets the last save time of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - cannotEdit?: boolean; + lastSaveTime?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - color?: boolean; + manager?: boolean; /** - * Gets an integer that represents the content control identifier. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - id?: boolean; + revisionNumber?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * 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.1] + * [Api set: WordApi 1.3] */ - placeholderText?: boolean; + security?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies the subject of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - removeWhenEdited?: boolean; + subject?: 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. + * Gets the template of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: boolean; + template?: 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. + * Specifies the title of the document. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn?: boolean; + title?: boolean; + } + /** + * 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 { /** - * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. - * - * @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`). */ - subtype?: boolean; + $all?: boolean; /** - * Specifies a tag to identify a content control. + * Gets a `LinkFormat` object that represents the link options of the field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: boolean; + linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** - * Gets the text of the content control. + * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** - * Specifies the title for a content control. + * Gets the parent body of the field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - title?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * 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.1] - */ - 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 { - /** - 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.4] */ - $all?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * 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. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * 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. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * 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. + * 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.1] + * [Api set: WordApi 1.4] */ - font?: Word.Interfaces.FontLoadOptions; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * 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. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the content control. + * Gets the field's result data. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + result?: Word.Interfaces.RangeLoadOptions; /** - * 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. + * Specifies the field's code instruction. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + code?: 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}. + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + data?: 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. + * Gets the field's kind. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentTable?: Word.Interfaces.TableLoadOptions; + kind?: 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. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + locked?: 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}. + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + showCodes?: 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}. + * Gets the field's type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + type?: boolean; + } + /** + * 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 { /** - * 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 BETA (PREVIEW ONLY)] - * @beta + 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`). */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + $all?: 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. + * 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 */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** - * 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. + * 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 */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** - * 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: Gets the parent body of the field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - appearance?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * 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 content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - cannotDelete?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * 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 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.1] + * [Api set: WordApi 1.4] */ - cannotEdit?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * 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: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - color?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * 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.1] + * [Api set: WordApi 1.4] */ - id?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * 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 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.1] + * [Api set: WordApi 1.4] */ - placeholderText?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * 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.1] + * [Api set: WordApi 1.4] */ - removeWhenEdited?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Gets the field's result data. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - style?: boolean; + result?: Word.Interfaces.RangeLoadOptions; /** - * 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. + * For EACH ITEM in the collection: Specifies the field's code instruction. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - styleBuiltIn?: boolean; + code?: 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, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * For EACH ITEM in the collection: Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - subtype?: boolean; + data?: boolean; /** - * For EACH ITEM in the collection: Specifies a tag to identify a content control. + * For EACH ITEM in the collection: Gets the field's kind. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - tag?: boolean; + kind?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the content control. + * For EACH ITEM in the collection: Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - text?: boolean; + locked?: boolean; /** - * For EACH ITEM in the collection: Specifies the title for a 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: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - title?: boolean; + showCodes?: boolean; /** - * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * For EACH ITEM in the collection: Gets the field's type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ type?: boolean; } /** - * Represents a list item in a dropdown list or combo box content control. + * Represents a font. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.1] */ - interface ContentControlListItemLoadOptions { + interface FontLoadOptions { /** 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. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: boolean; + fill?: Word.Interfaces.FillFormatLoadOptions; /** - * Specifies the index location of a content control list item in the collection of list items. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + glow?: Word.Interfaces.GlowFormatLoadOptions; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks - * [Api set: WordApi 1.9] - */ - value?: boolean; - } - /** - * 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 { - /** - 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 BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + line?: Word.Interfaces.LineFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control. + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: boolean; + reflection?: Word.Interfaces.ReflectionFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + textColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * * @remarks - * [Api set: WordApi 1.9] - */ - value?: boolean; - } - /** - * Represents a custom property. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface CustomPropertyLoadOptions { - /** - 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 BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + textShadow?: Word.Interfaces.ShadowFormatLoadOptions; /** - * Gets the key of the custom property. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: boolean; + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatLoadOptions; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, 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. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + allCaps?: 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). + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. * * @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`). + * [Api set: WordApi 1.1] */ - $all?: boolean; + bold?: boolean; /** - * For EACH ITEM in the collection: Gets the key of the custom property. + * 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: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: boolean; + boldBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - type?: boolean; + color?: 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). + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Represents a custom XML part. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CustomXmlPartLoadOptions { + colorIndex?: 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 color for the `Font` object in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + colorIndexBidirectional?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies whether contextual alternates are enabled for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + contextualAlternates?: boolean; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + diacriticColor?: boolean; /** - * Gets the ID of the custom XML part. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * Gets the namespace URI of the custom XML part. + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; + doubleStrikeThrough?: boolean; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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; + emboss?: 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`. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + emphasisMark?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + engrave?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - id?: boolean; + hidden?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * 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.4] + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; + highlightColor?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CustomXmlPartScopedCollectionLoadOptions { + italic?: 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 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + italicBidirectional?: 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`. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + kerning?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the ligature setting for the `Font` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + ligature?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Specifies a value that represents the name of the font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: boolean; + name?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: boolean; + nameAscii?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the font name in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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 { + nameBidirectional?: 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 East Asian font name. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nameFarEast?: boolean; /** - * Specifies a `Template` object that represents the template attached to the document. + * Specifies the font used for characters with codes from 128 through 255. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attachedTemplate?: Word.Interfaces.TemplateLoadOptions; + nameOther?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies the number form setting for an OpenType font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + numberForm?: boolean; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies the number spacing setting for the font. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyLoadOptions; + numberSpacing?: boolean; /** - * Returns a `PageSetup` object that's associated with the document. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + outline?: boolean; /** - * Gets the properties of the document. + * Specifies the position of text (in points) relative to the base line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + position?: boolean; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies the scaling percentage applied to the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation?: boolean; + scaling?: boolean; /** - * Specifies if the edits in the document are automatically saved. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + shadow?: boolean; /** - * Specifies the ChangeTracking mode. + * Specifies a value that represents the font size in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - changeTrackingMode?: boolean; + size?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies the font size in points for right-to-left text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: boolean; + sizeBidirectional?: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + smallCaps?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies the spacing between characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + spacing?: 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 value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. * * @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 { + strikeThrough?: 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 stylistic set for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + stylisticSet?: boolean; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.1] */ - body?: Word.Interfaces.BodyLoadOptions; + subscript?: boolean; /** - * Gets the properties of the document. + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.1] */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + superscript?: 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 value that indicates the font's underline type. 'None' if the font isn't underlined. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.1] */ - saved?: boolean; + underline?: boolean; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underlineColor?: boolean; } /** - * Represents document properties. + * Represents a hyperlink in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface DocumentPropertiesLoadOptions { + interface HyperlinkLoadOptions { /** 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 application name of the document. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - applicationName?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the author of the document. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: boolean; + address?: boolean; /** - * Specifies the category of the document. + * Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - category?: boolean; + emailSubject?: boolean; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comments?: boolean; + isExtraInfoRequired?: boolean; + /** + * Returns the name of the `Hyperlink` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + screenTip?: boolean; + /** + * Specifies a named location in the destination of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subAddress?: boolean; /** - * Specifies the company of the document. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - company?: boolean; + target?: boolean; /** - * Gets the creation date of the document. + * Specifies the hyperlink's visible text in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + textToDisplay?: boolean; /** - * Specifies the format of the document. + * Returns the hyperlink type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - format?: boolean; + type?: boolean; + } + /** + * Contains a collection of {@link Word.Hyperlink} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface HyperlinkCollectionLoadOptions { /** - * Specifies the keywords 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; + /** + * 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: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keywords?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the last author of the document. + * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastAuthor?: boolean; + address?: boolean; /** - * Gets the last print date of the document. + * For EACH ITEM in the collection: Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastPrintDate?: boolean; + emailSubject?: boolean; /** - * Gets the last save time of the document. + * For EACH ITEM in the collection: Returns `true` if extra information is required to resolve the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastSaveTime?: boolean; + isExtraInfoRequired?: boolean; /** - * Specifies the manager of the document. + * For EACH ITEM in the collection: Returns the name of the `Hyperlink` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - manager?: boolean; + name?: boolean; /** - * Gets the revision number of the document. + * 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: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - revisionNumber?: boolean; + screenTip?: 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. + * For EACH ITEM in the collection: Specifies a named location in the destination of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - security?: boolean; + subAddress?: boolean; /** - * Specifies the subject of the document. + * For EACH ITEM in the collection: Specifies the name of the frame or window in which to load the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subject?: boolean; + target?: boolean; /** - * Gets the template of the document. + * For EACH ITEM in the collection: Specifies the hyperlink's visible text in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - template?: boolean; + textToDisplay?: boolean; /** - * Specifies the title of the document. + * For EACH ITEM in the collection: Returns the hyperlink type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: boolean; + type?: boolean; } /** - * Represents a field. + * Represents an inline picture. * * @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.1] */ - interface FieldLoadOptions { + interface InlinePictureLoadOptions { /** 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. + * Gets the parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.2] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * 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 inline image. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ 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}. + * 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.4] + * [Api set: WordApi 1.3] */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained 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.4] + * [Api set: WordApi 1.3] */ 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. + * 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.4] + * [Api set: WordApi 1.3] */ 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}. + * 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.4] + * [Api set: WordApi 1.3] */ 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}. + * 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.4] + * [Api set: WordApi 1.3] */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the field's result data. + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - result?: Word.Interfaces.RangeLoadOptions; + altTextDescription?: boolean; /** - * Specifies the field's code instruction. + * Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi 1.1] */ - code?: boolean; + altTextTitle?: boolean; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - data?: boolean; + height?: boolean; /** - * Gets the field's kind. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - kind?: boolean; + hyperlink?: boolean; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - locked?: boolean; + imageFormat?: boolean; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - showCodes?: boolean; + lockAspectRatio?: boolean; /** - * Gets the field's type. + * Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - type?: boolean; + width?: boolean; } /** - * Contains a collection of {@link Word.Field} objects. + * Contains a collection of {@link Word.InlinePicture} 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}. + * [Api set: WordApi 1.1] */ - interface FieldCollectionLoadOptions { + interface InlinePictureCollectionLoadOptions { /** 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. + * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.2] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * 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. + * 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.4] + * [Api set: WordApi 1.1] */ 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}. + * 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.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. + * 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.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. + * 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.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}. + * 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.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}. + * 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.4] + * [Api set: WordApi 1.3] */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the field's result data. + * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - result?: Word.Interfaces.RangeLoadOptions; + altTextDescription?: boolean; /** - * For EACH ITEM in the collection: Specifies the field's code instruction. + * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi 1.1] */ - code?: boolean; + altTextTitle?: boolean; /** - * For EACH ITEM in the collection: Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - data?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: Gets the field's kind. + * 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: WordApi 1.5] + * [Api set: WordApi 1.1] */ - kind?: boolean; + hyperlink?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * For EACH ITEM in the collection: Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - locked?: boolean; + imageFormat?: 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. + * 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.1] + * [Api set: WordApi 1.1] */ - showCodes?: boolean; + lockAspectRatio?: boolean; /** - * For EACH ITEM in the collection: Gets the field's type. + * For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - type?: boolean; + width?: boolean; } /** - * Represents a font. + * Represents the linking characteristics for an OLE object or picture. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface FontLoadOptions { + interface LinkFormatLoadOptions { /** 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - glow?: Word.Interfaces.GlowFormatLoadOptions; - /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - line?: Word.Interfaces.LineFormatLoadOptions; - /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - reflection?: Word.Interfaces.ReflectionFormatLoadOptions; - /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textColor?: Word.Interfaces.ColorFormatLoadOptions; - /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textShadow?: Word.Interfaces.ShadowFormatLoadOptions; - /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - 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. + * 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 */ - allCaps?: boolean; - /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. - * - * @remarks - * [Api set: WordApi 1.1] - */ - bold?: boolean; + isAutoUpdated?: 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 if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; - /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. - * - * @remarks - * [Api set: WordApi 1.1] - */ - color?: boolean; + isLocked?: boolean; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: boolean; + isPictureSavedWithDocument?: boolean; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * 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 */ - colorIndexBidirectional?: boolean; + sourceFullName?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates?: boolean; + sourceName?: boolean; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: boolean; + sourcePath?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Gets the link type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + type?: boolean; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListLoadOptions { /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, 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; + /** + * Gets the list's id. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - doubleStrikeThrough?: boolean; + id?: 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. + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - emboss?: boolean; + levelExistences?: boolean; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - emphasisMark?: boolean; + levelTypes?: boolean; + } + /** + * Contains a collection of {@link Word.List} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListCollectionLoadOptions { /** - * 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. + 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - engrave?: boolean; + id?: boolean; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - hidden?: boolean; + levelExistences?: 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: 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] */ - highlightColor?: boolean; + levelTypes?: boolean; + } + /** + * Represents the paragraph list item format. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListItemLoadOptions { /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, 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; + /** + * Specifies the level of the item in the list. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - italic?: boolean; + level?: 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 list item bullet, number, or picture as a string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - italicBidirectional?: boolean; + listString?: boolean; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Gets the list item order number in relation to its siblings. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - kerning?: boolean; + siblingIndex?: boolean; + } + /** + * Represents a list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface ListLevelLoadOptions { /** - * Specifies the ligature setting for the `Font` 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 Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - ligature?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies a value that represents the name of the font. + * 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] */ - name?: boolean; + alignment?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameAscii?: boolean; + linkedStyle?: boolean; /** - * Specifies the font name in a right-to-left language document. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameBidirectional?: boolean; + numberFormat?: boolean; /** - * Specifies the East Asian font name. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameFarEast?: boolean; + numberPosition?: boolean; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameOther?: boolean; + numberStyle?: boolean; /** - * Specifies the number form setting for an OpenType font. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - numberForm?: boolean; + resetOnHigher?: boolean; /** - * Specifies the number spacing setting for the font. + * Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - numberSpacing?: boolean; + startAt?: 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. + * Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - outline?: boolean; + tabPosition?: boolean; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - position?: boolean; + textPosition?: boolean; /** - * Specifies the scaling percentage applied to the font. + * Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - scaling?: boolean; + trailingCharacter?: boolean; + } + /** + * Contains a collection of {@link Word.ListLevel} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface ListLevelCollectionLoadOptions { /** - * 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; + /** + * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - shadow?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies a value that represents the font size in points. + * 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: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - size?: boolean; + alignment?: boolean; /** - * Specifies the font size in points for right-to-left text. + * For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sizeBidirectional?: boolean; + linkedStyle?: 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 number format for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - smallCaps?: boolean; + numberFormat?: boolean; /** - * Specifies the spacing between characters. + * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spacing?: boolean; + numberPosition?: boolean; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * For EACH ITEM in the collection: Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - strikeThrough?: boolean; + numberStyle?: boolean; /** - * Specifies the stylistic set for the font. + * For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - stylisticSet?: boolean; + resetOnHigher?: boolean; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * For EACH ITEM in the collection: Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - subscript?: boolean; + startAt?: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * For EACH ITEM in the collection: Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - superscript?: boolean; + tabPosition?: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - underline?: boolean; + textPosition?: 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 character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - underlineColor?: boolean; + trailingCharacter?: boolean; } /** - * Represents a hyperlink in a Word document. + * Represents a list template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - interface HyperlinkLoadOptions { + interface ListTemplateLoadOptions { /** 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. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - address?: boolean; + outlineNumbered?: boolean; + } + /** + * Represents a footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface NoteItemLoadOptions { /** - * Specifies the text string for the hyperlink's subject line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - emailSubject?: boolean; + $all?: boolean; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isExtraInfoRequired?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Returns the name of the `Hyperlink` object. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - name?: boolean; + reference?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - screenTip?: boolean; + type?: boolean; + } + /** + * Contains a collection of {@link Word.NoteItem} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface NoteItemCollectionLoadOptions { /** - * Specifies a named location in the destination of the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - subAddress?: boolean; + $all?: boolean; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - target?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the hyperlink's visible text in the document. + * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - textToDisplay?: boolean; + reference?: Word.Interfaces.RangeLoadOptions; /** - * Returns the hyperlink type. + * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ type?: boolean; } /** - * Contains a collection of {@link Word.Hyperlink} objects. + * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface HyperlinkCollectionLoadOptions { + interface OleFormatLoadOptions { /** 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. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: boolean; + classType?: boolean; /** - * For EACH ITEM in the collection: Specifies the text string for the hyperlink's subject line. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: boolean; + iconIndex?: boolean; /** - * For EACH ITEM in the collection: Returns `true` if extra information is required to resolve the hyperlink. + * Specifies the text displayed below the icon for the OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isExtraInfoRequired?: boolean; + iconLabel?: boolean; /** - * For EACH ITEM in the collection: Returns the name of the `Hyperlink` object. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + iconName?: boolean; /** - * For EACH ITEM in the collection: Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screenTip?: boolean; + iconPath?: boolean; /** - * For EACH ITEM in the collection: Specifies a named location in the destination of the hyperlink. + * Gets whether the specified object is displayed as an icon. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subAddress?: boolean; + isDisplayedAsIcon?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the frame or window in which to load the hyperlink. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - target?: boolean; + isFormattingPreservedOnUpdate?: boolean; /** - * For EACH ITEM in the collection: Specifies the hyperlink's visible text in the document. + * 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 */ - textToDisplay?: boolean; + label?: boolean; /** - * For EACH ITEM in the collection: Returns the hyperlink type. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + progID?: boolean; } /** - * Represents an inline picture. + * 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] */ - interface InlinePictureLoadOptions { + interface PageLoadOptions { /** 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; - /** - * 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; - /** - * 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; - /** - * 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}. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + height?: 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}. + * 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.3] + * [Api set: WordApiDesktop 1.2] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + index?: boolean; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - altTextDescription?: boolean; + width?: boolean; + } + /** + * Represents the collection of page. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface PageCollectionLoadOptions { /** - * Specifies a string that contains the title for 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`). */ - altTextTitle?: boolean; + $all?: boolean; /** - * Specifies a number that describes the height of the inline image. + * For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ height?: boolean; /** - * 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?: boolean; - /** - * Gets the format of the inline image. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - imageFormat?: 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 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] + * [Api set: WordApiDesktop 1.2] */ - lockAspectRatio?: boolean; + index?: boolean; /** - * Specifies a number that describes the width of the inline image. + * For EACH ITEM in the collection: Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ width?: boolean; } /** - * Contains a collection of {@link Word.InlinePicture} objects. + * Represents the window that displays the document. A window can be split to contain multiple reading panes. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - interface InlinePictureCollectionLoadOptions { + 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; /** - * 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}. + * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + next?: Word.Interfaces.WindowLoadOptions; /** - * 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. + * Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + previous?: Word.Interfaces.WindowLoadOptions; /** - * 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. + * Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + view?: Word.Interfaces.ViewLoadOptions; /** - * 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}. + * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + areRulersDisplayed?: 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}. + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + areScreenTipsDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. + * 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.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: boolean; + areThumbnailsDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: boolean; + caption?: boolean; /** - * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. + * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ height?: 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. - * - * @remarks - * [Api set: WordApi 1.1] - */ - hyperlink?: boolean; - /** - * For EACH ITEM in the collection: Gets the format of the inline image. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - imageFormat?: boolean; + horizontalPercentScrolled?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + imemode?: boolean; /** - * For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. + * Gets the position of an item in a collection. * * @remarks - * [Api set: WordApi 1.1] - */ - width?: boolean; - } - /** - * Contains a collection of {@link Word.Paragraph} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface 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`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + index?: boolean; /** - * Gets the list's id. + * Specifies whether the window is active. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + isActive?: boolean; /** - * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelExistences?: boolean; + isDocumentMapVisible?: boolean; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApi 1.3] - */ - levelTypes?: boolean; - } - /** - * Contains a collection of {@link Word.List} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ListCollectionLoadOptions { - /** - 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 BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isEnvelopeVisible?: boolean; /** - * For EACH ITEM in the collection: Gets the list's id. + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + isHorizontalScrollBarDisplayed?: boolean; /** - * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelExistences?: boolean; + isLeftScrollBarDisplayed?: 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 the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelTypes?: boolean; - } - /** - * Represents the paragraph list item format. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ListItemLoadOptions { + 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`). + * Specifies whether the window is split into multiple panes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isSplit?: boolean; /** - * Specifies the level of the item in the list. + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level?: boolean; + isVerticalRulerDisplayed?: boolean; /** - * Gets the list item bullet, number, or picture as a string. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listString?: boolean; + isVerticalScrollBarDisplayed?: boolean; /** - * Gets the list item order number in relation to its siblings. + * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - siblingIndex?: boolean; - } - /** - * Represents a list level. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface ListLevelLoadOptions { + 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + left?: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + showSourceDocuments?: boolean; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + splitVertical?: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies the width of the style area in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: boolean; + styleAreaWidth?: boolean; /** - * Specifies the number format for the specified list level. + * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: boolean; + top?: boolean; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Gets the window type. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: boolean; + type?: boolean; /** - * Specifies the number style for the list level object. + * Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: boolean; + usableHeight?: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: boolean; + usableWidth?: boolean; /** - * Specifies the starting number for the specified list level object. + * Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: boolean; + verticalPercentScrolled?: boolean; /** - * Specifies the tab position for the specified list level object. + * Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: boolean; + width?: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: boolean; + windowNumber?: boolean; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the state of the document window or task window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: boolean; + windowState?: boolean; } /** - * Contains a collection of {@link Word.ListLevel} objects. + * Represents the collection of window objects. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - interface ListLevelCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object. + * For EACH ITEM in the collection: Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + next?: Word.Interfaces.WindowLoadOptions; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * For EACH ITEM in the collection: Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + previous?: Word.Interfaces.WindowLoadOptions; /** - * For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object. + * For EACH ITEM in the collection: Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: boolean; + view?: Word.Interfaces.ViewLoadOptions; /** - * For EACH ITEM in the collection: Specifies the number format for the specified list level. + * For EACH ITEM in the collection: Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: boolean; + areRulersDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: boolean; + areScreenTipsDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies the number style for the list level object. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: boolean; + areThumbnailsDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1. + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: boolean; + caption?: boolean; /** - * For EACH ITEM in the collection: Specifies the starting number for the specified list level object. + * For EACH ITEM in the collection: Specifies the height of the window (in points). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: Specifies the tab position for the specified list level object. + * For EACH ITEM in the collection: Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: boolean; + horizontalPercentScrolled?: boolean; /** - * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * For EACH ITEM in the collection: Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: boolean; + imemode?: boolean; /** - * For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level. + * For EACH ITEM in the collection: Gets the position of an item in a collection. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: boolean; - } - /** - * Represents a ListTemplate. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface ListTemplateLoadOptions { + index?: 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 active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isActive?: boolean; /** - * Specifies whether the specified ListTemplate object is outline numbered. + * For EACH ITEM in the collection: Specifies whether the document map is visible. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineNumbered?: boolean; - } - /** - * Represents a footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface NoteItemLoadOptions { + isDocumentMapVisible?: 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 email message header is visible in the document window. The default value is `False`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isEnvelopeVisible?: boolean; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * For EACH ITEM in the collection: Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyLoadOptions; + isHorizontalScrollBarDisplayed?: boolean; /** - * Represents a footnote or endnote reference in the main document. + * 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 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reference?: Word.Interfaces.RangeLoadOptions; + isLeftScrollBarDisplayed?: boolean; /** - * Represents the note item type: footnote or endnote. + * 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 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; - } - /** - * Contains a collection of {@link Word.NoteItem} objects. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface NoteItemCollectionLoadOptions { + 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isSplit?: 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. + * For EACH ITEM in the collection: Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyLoadOptions; + isVerticalRulerDisplayed?: boolean; /** - * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. + * For EACH ITEM in the collection: Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reference?: Word.Interfaces.RangeLoadOptions; + isVerticalScrollBarDisplayed?: boolean; /** - * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. + * For EACH ITEM in the collection: Specifies whether the window is visible. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; - } - /** - * Represents a page in the document. `Page` objects manage the page layout and content. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface PageLoadOptions { + 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`). + * For EACH ITEM in the collection: Specifies the horizontal position of the window, measured in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + left?: boolean; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * For EACH ITEM in the collection: Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: boolean; + showSourceDocuments?: 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 vertical split percentage for the window. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + splitVertical?: boolean; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * For EACH ITEM in the collection: Specifies the width of the style area in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; - } - /** - * Represents the collection of page. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface PageCollectionLoadOptions { + styleAreaWidth?: 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 position of the document window, in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + top?: 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: Gets the window type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: boolean; + type?: 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: Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + usableHeight?: 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: Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 */ 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 + */ + 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. @@ -145403,12 +153240,12 @@ declare namespace Word { */ font?: Word.Interfaces.FontLoadOptions; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ listFormat?: Word.Interfaces.ListFormatLoadOptions; /** * Gets the parent body of the range. @@ -145467,6 +153304,86 @@ declare namespace Word { * @beta */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; + /** + * Specifies whether the range is formatted as bold. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + boldBidirectional?: boolean; + /** + * Specifies a `CharacterCase` value that represents the case of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + case?: boolean; + /** + * Specifies the character width of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + characterWidth?: boolean; + /** + * Specifies if the range contains combined characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + disableCharacterSpaceGrid?: boolean; + /** + * Specifies the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emphasisMark?: boolean; + /** + * Specifies the ending character position of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + fitTextWidth?: boolean; + /** + * Specifies if a grammar check has been run on the range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grammarChecked?: boolean; /** * Specifies the proofing status (spelling and grammar checking) of the range. * @@ -145475,6 +153392,22 @@ declare namespace Word { * @beta */ hasNoProofing?: boolean; + /** + * Specifies the highlight color for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + highlightColorIndex?: boolean; + /** + * Specifies the formatting for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalInVertical?: 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. * @@ -145482,6 +153415,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ hyperlink?: boolean; + /** + * Specifies the ID for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; /** * Checks whether the range length is zero. * @@ -145489,6 +153430,46 @@ declare namespace Word { * [Api set: WordApi 1.3] */ isEmpty?: boolean; + /** + * 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 + */ + isEndOfRowMark?: boolean; + /** + * Gets whether the text in the range is visible on the screen. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTextVisibleOnScreen?: boolean; + /** + * Specifies if the font or range is formatted as italic. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italic?: boolean; + /** + * Specifies if the font or range is formatted as italic (right-to-left languages). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italicBidirectional?: boolean; + /** + * Specifies whether the range of Japanese language text is hiragana or katakana. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kana?: boolean; /** * Specifies whether Microsoft Word has detected the language of the text in the range. * @@ -145521,6 +153502,46 @@ declare namespace Word { * @beta */ languageIdOther?: boolean; + /** + * 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 + */ + showAll?: boolean; + /** + * Specifies if spelling has been checked throughout the range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spellingChecked?: boolean; + /** + * Specifies the starting character position of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start?: boolean; + /** + * Gets the number of characters in the story that contains the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + storyLength?: boolean; + /** + * Gets the story type for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + storyType?: 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. * @@ -145542,6 +153563,22 @@ declare namespace Word { * [Api set: WordApi 1.1] */ text?: boolean; + /** + * 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 + */ + twoLinesInOne?: boolean; + /** + * Specifies the type of underline applied to the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underline?: boolean; } /** * Contains a collection of {@link Word.Range} objects. @@ -145562,12 +153599,12 @@ declare namespace Word { */ 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: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * 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)] + * @beta + */ listFormat?: Word.Interfaces.ListFormatLoadOptions; /** * For EACH ITEM in the collection: Gets the parent body of the range. @@ -145626,6 +153663,86 @@ declare namespace Word { * @beta */ 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 + */ + 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 + */ + 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 + */ + case?: boolean; + /** + * For EACH ITEM in the collection: Specifies the character width of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + characterWidth?: boolean; + /** + * For EACH ITEM in the collection: Specifies if the range contains combined characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + emphasisMark?: boolean; + /** + * For EACH ITEM in the collection: Specifies the ending character position of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + grammarChecked?: boolean; /** * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. * @@ -145634,6 +153751,22 @@ declare namespace Word { * @beta */ hasNoProofing?: boolean; + /** + * For EACH ITEM in the collection: Specifies the highlight color for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + horizontalInVertical?: 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. * @@ -145641,6 +153774,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ hyperlink?: boolean; + /** + * For EACH ITEM in the collection: Specifies the ID for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; /** * For EACH ITEM in the collection: Checks whether the range length is zero. * @@ -145648,6 +153789,46 @@ declare namespace Word { * [Api set: WordApi 1.3] */ isEmpty?: boolean; + /** + * 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 + */ + 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 + */ + 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 + */ + 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 + */ + 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 + */ + kana?: boolean; /** * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. * @@ -145680,6 +153861,46 @@ declare namespace Word { * @beta */ languageIdOther?: boolean; + /** + * 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 + */ + 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 + */ + spellingChecked?: boolean; + /** + * For EACH ITEM in the collection: Specifies the starting character position of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + storyLength?: boolean; + /** + * For EACH ITEM in the collection: Gets the story type for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + storyType?: 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. * @@ -145701,6 +153922,22 @@ declare namespace Word { * [Api set: WordApi 1.1] */ text?: boolean; + /** + * 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 + */ + twoLinesInOne?: boolean; + /** + * For EACH ITEM in the collection: Specifies the type of underline applied to the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underline?: boolean; } /** * Specifies the options to be included in a search operation. @@ -145818,12 +154055,12 @@ declare namespace Word { */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** * For EACH ITEM in the collection: Specifies if the section is protected for forms. @@ -146650,6 +154887,128 @@ declare namespace Word { */ topCellMargin?: boolean; } + /** + * Represents a tab stop in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TabStopLoadOptions { + /** + 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 next tab stop in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + next?: Word.Interfaces.TabStopLoadOptions; + /** + * Gets the previous tab stop in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previous?: Word.Interfaces.TabStopLoadOptions; + /** + * Gets a `TabAlignment` value that represents the alignment for the tab stop. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + alignment?: boolean; + /** + * Gets whether this tab stop is a custom tab stop. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customTab?: boolean; + /** + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leader?: boolean; + /** + * Gets the position of the tab stop relative to the left margin. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position?: boolean; + } + /** + * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TabStopCollectionLoadOptions { + /** + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + 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 + */ + 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 + */ + 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 + */ + position?: boolean; + } /** * Contains the collection of the document's Table objects. * @@ -147700,6 +156059,435 @@ declare namespace Word { */ type?: boolean; } + /** + * 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 + */ + 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; + /** + * Gets the instance of a `RevisionsFilter` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + revisionsFilter?: Word.Interfaces.RevisionsFilterLoadOptions; + /** + * Specifies whether all nonprinting characters are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areBackgroundsDisplayed?: boolean; + /** + * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areBookmarksIndicated?: boolean; + /** + * Specifies whether Microsoft Word displays the comments in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + areCropMarksDisplayed?: boolean; + /** + * Gets whether objects created with the drawing tools are displayed in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areEditableRangesShaded?: boolean; + /** + * Specifies whether field codes are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areFormatChangesDisplayed?: boolean; + /** + * Specifies whether handwritten ink annotations are shown or hidden. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + 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 + */ + areObjectAnchorsDisplayed?: boolean; + /** + * Gets whether Microsoft Word displays optional line breaks. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areOptionalBreaksDisplayed?: boolean; + /** + * Gets whether optional hyphens are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areOptionalHyphensDisplayed?: boolean; + /** + * Gets whether other authors' presence should be visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + arePageBoundariesDisplayed?: boolean; + /** + * Gets whether paragraph marks are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areParagraphsMarksDisplayed?: boolean; + /** + * Gets whether blank boxes are displayed as placeholders for pictures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areRevisionsAndCommentsDisplayed?: boolean; + /** + * Gets whether space characters are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areSpacesIndicated?: boolean; + /** + * Specifies whether table gridlines are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areTableGridlinesDisplayed?: boolean; + /** + * Gets whether tab characters are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + areTextBoundariesDisplayed?: boolean; + /** + * Specifies the column width in Reading mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columnWidth?: boolean; + /** + * Gets on-screen shading for fields. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + isDraft?: boolean; + /** + * Specifies whether only the first line of body text is shown in outline view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFirstLineOnlyDisplayed?: boolean; + /** + * Specifies whether character formatting is visible in outline view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFormatDisplayed?: boolean; + /** + * Specifies whether the window is in full-screen view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFullScreen?: boolean; + /** + * Gets whether text formatted as hidden text is displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isHiddenTextDisplayed?: boolean; + /** + * Gets whether highlight formatting is displayed and printed with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isHighlightingDisplayed?: boolean; + /** + * Specifies whether the document is in conflict mode view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isInConflictMode?: boolean; + /** + * Specifies whether Microsoft Word is in Panning mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isInPanning?: boolean; + /** + * Specifies whether the document is being viewed in reading layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isInReadingLayout?: boolean; + /** + * Specifies whether mail merge data is displayed instead of mail merge fields. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + isMainTextLayerVisible?: boolean; + /** + * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + isReadingLayoutActualView?: boolean; + /** + * Specifies whether XML tags are visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isXmlMarkupVisible?: boolean; + /** + * Specifies the display mode for tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + markupMode?: boolean; + /** + * Specifies the page color in Reading mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageColor?: boolean; + /** + * Specifies the page movement type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + revisionsBalloonSide?: boolean; + /** + * Specifies the width of the revision balloons. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + revisionsBalloonWidth?: boolean; + /** + * Specifies how Microsoft Word measures the width of revision balloons. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + revisionsBalloonWidthType?: boolean; + /** + * Specifies the document element displayed in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + seekView?: boolean; + /** + * Specifies the active window pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + splitSpecial?: boolean; + /** + * Specifies the view type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: 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. * @@ -148372,6 +157160,77 @@ declare namespace Word { */ 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ReviewerLoadOptions { + /** + 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 BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ReviewerCollectionLoadOptions { + /** + 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 BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + } + /** + * 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 + */ + interface RevisionsFilterLoadOptions { + /** + 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 BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + view?: boolean; + } /** * Represents a single item in a {@link Word.RepeatingSectionControlControl}. * @@ -149366,6 +158225,51 @@ declare namespace Word { */ modifiedBy?: boolean; } + /** + * Represents a dropped capital letter in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DropCapLoadOptions { + /** + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + distanceFromText?: boolean; + /** + * Gets the name of the font for the dropped capital letter. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fontName?: boolean; + /** + * Gets the height (in lines) of the dropped capital letter. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + linesToDrop?: boolean; + /** + * Gets the position of the dropped capital letter. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position?: boolean; + } /** * Represents the list formatting characteristics of a range. * @@ -149456,20 +158360,20 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. @@ -149648,12 +158552,12 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ color?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the length of the radius for a glow effect. @@ -149686,20 +158590,20 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the length of the arrowhead at the beginning of the line. @@ -149925,12 +158829,12 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. @@ -150029,20 +158933,20 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ contourColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ extrusionColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the depth of the bottom bevel. @@ -150698,6 +159602,338 @@ declare namespace Word { */ width?: boolean; } + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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; + /** + * 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 + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Specifies the ending character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end?: boolean; + /** + * Returns `true` if the bookmark is a table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isColumn?: boolean; + /** + * Returns `true` if the bookmark is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isEmpty?: boolean; + /** + * Returns the name of the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * Specifies the starting character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start?: boolean; + /** + * Returns the story type for the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + storyType?: boolean; + } + /** + * 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 + */ + interface BookmarkCollectionLoadOptions { + /** + 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 in the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + isColumn?: boolean; + /** + * For EACH ITEM in the collection: Returns `true` if the bookmark is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isEmpty?: boolean; + /** + * For EACH ITEM in the collection: Returns the name of the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies the starting character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start?: boolean; + /** + * For EACH ITEM in the collection: Returns the story type for the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface IndexLoadOptions { + /** + 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 is contained within the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + filter?: boolean; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + headingSeparator?: boolean; + /** + * Gets a `LanguageId` value that represents the sorting language to use for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indexLanguage?: boolean; + /** + * Gets the number of columns for each page of the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberOfColumns?: boolean; + /** + * Specifies if page numbers are aligned with the right margin in the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separateAccentedLetterHeadings?: boolean; + /** + * Specifies the sorting criteria for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortBy?: boolean; + /** + * Specifies the leader character between entries in the index and their associated page numbers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabLeader?: boolean; + /** + * Gets the index type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; + } + /** + * A collection of {@link Word.Index} objects that represents all the indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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; + /** + * 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 + */ + 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + filter?: boolean; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + 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 + */ + 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 + */ + rightAlignPageNumbers?: boolean; + /** + * 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separateAccentedLetterHeadings?: boolean; + /** + * For EACH ITEM in the collection: Specifies the sorting criteria for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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 + */ + tabLeader?: boolean; + /** + * For EACH ITEM in the collection: Gets the index type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; + } } } declare namespace Word { diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 482eefbb305d20..c10e1df00a3908 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -108252,7 +108252,7 @@ declare namespace Word { /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ interface ListTemplateUpdateData { /** - * Specifies whether the specified ListTemplate object is outline numbered. + * Specifies whether the list template is outline numbered. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -110588,14 +110588,14 @@ declare namespace Word { /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ interface ListTemplateData { /** - * Gets a ListLevels collection that represents all the levels for the specified ListTemplate. + * Gets a `ListLevelCollection` object that represents all the levels for the list template. * * @remarks * [Api set: WordApiDesktop 1.1] */ listLevels?: Word.Interfaces.ListLevelData[]; /** - * Specifies whether the specified ListTemplate object is outline numbered. + * Specifies whether the list template is outline numbered. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -114289,7 +114289,7 @@ declare namespace Word { trailingCharacter?: boolean; } /** - * Represents a ListTemplate. + * Represents a list template. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -114300,7 +114300,7 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies whether the specified ListTemplate object is outline numbered. + * Specifies whether the list template is outline numbered. * * @remarks * [Api set: WordApiDesktop 1.1] diff --git a/types/react-native-snap-carousel/package.json b/types/react-native-snap-carousel/package.json index 63dd97853e5936..20e2b22cb1e044 100644 --- a/types/react-native-snap-carousel/package.json +++ b/types/react-native-snap-carousel/package.json @@ -6,7 +6,9 @@ "https://github.com/archriss/react-native-snap-carousel" ], "dependencies": { - "@types/react": "*", + "@types/react": "*" + }, + "peerDependencies": { "react-native": "*" }, "devDependencies": { diff --git a/types/umami/index.d.ts b/types/umami/index.d.ts index 740e4a327811ed..138fa3c3ae4afb 100644 --- a/types/umami/index.d.ts +++ b/types/umami/index.d.ts @@ -25,5 +25,17 @@ declare namespace umami { website: string; }) => { website: string; [key: string]: any }, ): Promise | undefined; + + /** Pass in your own ID to identify a user. */ + identify(identity_id: string): Promise; + + /** Save data about the current session. */ + identify( + indentity_id: string, + data: Record, + ): Promise; + + /** To save data without a unique ID, pass in only a JSON object. */ + identify(data: Record): Promise; } } diff --git a/types/umami/umami-tests.ts b/types/umami/umami-tests.ts index 4fb36c1ee304c8..8bc539526dcaff 100644 --- a/types/umami/umami-tests.ts +++ b/types/umami/umami-tests.ts @@ -16,3 +16,10 @@ umami.track(props => ({ id: 123, }, })); + +// identify +umami.identify("123"); + +umami.identify("123", { name: "test" }); + +umami.identify({ name: "test" });