diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 7c85c790e516ad..a7652c2534ec91 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -100745,7 +100745,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index The index of the object in this collection. + * @param index The index of the item to retrieve. */ getItemAt(index: number): Word.Editor; /** @@ -100772,15 +100772,15 @@ declare namespace Word { */ untrack(): Word.EditorCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.EditorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.EditorCollectionData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.EditorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.EditorCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; } /** - * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -100883,9 +100883,9 @@ declare namespace Word { */ untrack(): Word.Editor; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Editor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.EditorData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Editor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.EditorData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.EditorData; } /** @@ -100915,7 +100915,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a `Conflict` object. + * @param index The location of a `Conflict` object. */ getItem(index: number): Word.Conflict; /** @@ -100953,9 +100953,9 @@ declare namespace Word { */ untrack(): Word.ConflictCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ConflictCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConflictCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ConflictCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConflictCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ConflictCollectionData; } /** @@ -101038,9 +101038,9 @@ declare namespace Word { */ untrack(): Word.Conflict; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Conflict` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConflictData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Conflict` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConflictData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ConflictData; } /** @@ -101089,28 +101089,28 @@ declare namespace Word { */ interface CritiquePopupOptions { /** - * Gets the manifest resource ID of the string to use for branding. This branding text appears next to your add-in icon in the pop-up menu. + * Specifies the manifest resource ID of the string to use for branding. This branding text appears next to your add-in icon in the pop-up menu. * * @remarks * [Api set: WordApi 1.8] */ brandingTextResourceId: string; /** - * Gets the manifest resource ID of the string to use as the subtitle. + * Specifies the manifest resource ID of the string to use as the subtitle. * * @remarks * [Api set: WordApi 1.8] */ subtitleResourceId: string; /** - * Gets the suggestions to display in the critique pop-up menu. + * Specifies the suggestions to display in the critique pop-up menu. * * @remarks * [Api set: WordApi 1.8] */ suggestions: string[]; /** - * Gets the manifest resource ID of the string to use as the title. + * Specifies the manifest resource ID of the string to use as the title. * * @remarks * [Api set: WordApi 1.8] @@ -101220,9 +101220,9 @@ declare namespace Word { */ untrack(): Word.CritiqueAnnotation; /** - * 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.CritiqueAnnotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CritiqueAnnotationData`) 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.CritiqueAnnotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CritiqueAnnotationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CritiqueAnnotationData; } /** @@ -101276,14 +101276,14 @@ declare namespace Word { /** 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 critique annotation object. + * Gets the `CritiqueAnnotation` object. * * @remarks * [Api set: WordApi 1.7] */ readonly critiqueAnnotation: Word.CritiqueAnnotation; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. * * @remarks * [Api set: WordApi 1.7] @@ -101333,9 +101333,9 @@ declare namespace Word { */ untrack(): Word.Annotation; /** - * 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.Annotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationData`) 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.Annotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.AnnotationData; } /** @@ -101481,13 +101481,13 @@ declare namespace Word { */ untrack(): Word.AnnotationCollection; /** - * 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.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.AnnotationCollectionData; } /** - * Represents the application object. + * Represents the `Application` object. * * @remarks * [Api set: WordApi 1.3] @@ -101553,7 +101553,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param base64File Optional. The Base64-encoded .docx file. The default value is null. + * @param base64File Optional. The Base64-encoded .docx file. The default value is `null`. */ createDocument(base64File?: string): Word.DocumentCreated; /** @@ -101569,7 +101569,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] * - * @param filePath Required. The absolute path of the .docx file. Word on the web only supports remote (cloud) locations, while Word on Windows, on Mac, and on iOS support local and remote locations. + * @param filePath The absolute path of the .docx file. Word on the web only supports remote (cloud) locations, while Word on Windows, on Mac, and on iOS support local and remote locations. */ openDocument(filePath: string): void; /** @@ -101578,7 +101578,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param base64File Required. The template file. + * @param base64File The template file. */ retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult; /** @@ -101607,9 +101607,9 @@ declare namespace Word { */ static newObject(context: OfficeExtension.ClientRequestContext): Word.Application; /** - * 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.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ApplicationData`) 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.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ApplicationData; } /** @@ -101636,7 +101636,7 @@ declare namespace Word { */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the body. + * Gets the collection of `Field` objects in the body. * * @remarks * [Api set: WordApi 1.4] @@ -101657,21 +101657,21 @@ declare namespace Word { */ readonly footnotes: Word.NoteItemCollection; /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. + * Gets the collection of `InlinePicture` objects in the body. The collection doesn't include floating images. * * @remarks * [Api set: WordApi 1.1] */ readonly inlinePictures: Word.InlinePictureCollection; /** - * Gets the collection of list objects in the body. + * Gets the collection of `List` objects in the body. * * @remarks * [Api set: WordApi 1.3] */ readonly lists: Word.ListCollection; /** - * Gets the collection of paragraph objects in the body. + * Gets the collection of `Paragraph` objects in the body. * * @remarks * [Api set: WordApi 1.1] @@ -101722,14 +101722,16 @@ declare namespace Word { */ readonly parentSectionOrNullObject: Word.Section; /** - * 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. + * Gets the collection of `Shape` objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. */ readonly shapes: Word.ShapeCollection; /** - * Gets the collection of table objects in the body. + * Gets the collection of `Table` objects in the body. * * @remarks * [Api set: WordApi 1.3] @@ -101750,14 +101752,14 @@ declare namespace Word { */ styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Gets the text of the body. Use the insertText method to insert text. + * Gets the text of the body. Use the `insertText` method to insert text. * * @remarks * [Api set: WordApi 1.1] */ readonly text: string; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * Gets the type of the body. The type can be `mainDoc`, `section`, `header`, `footer`, or `tableCell`. Additional types `footnote`, `endnote`, and `noteItem` are supported in WordApi 1.5 and later. * * @remarks * [Api set: WordApi 1.3] @@ -101772,7 +101774,7 @@ declare namespace Word { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Word.Body): void; /** - * Clears the contents of the body object. The user can perform the undo operation on the cleared content. + * Clears the contents of the `Body` object. The user can perform the undo operation on the cleared content. * * @remarks * [Api set: WordApi 1.1] @@ -101799,14 +101801,14 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the `Body` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. * * @remarks * [Api set: WordApi 1.1] */ getHtml(): OfficeExtension.ClientResult; /** - * Gets the OOXML (Office Open XML) representation of the body object. + * Gets the OOXML (Office Open XML) representation of the `Body` object. * * @remarks * [Api set: WordApi 1.1] @@ -101818,7 +101820,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `after`, or `content`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; /** @@ -101827,7 +101829,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** @@ -101836,11 +101838,11 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Gets the collection of the TrackedChange objects in the body. + * Gets the collection of the `TrackedChange` objects in the body. * * @remarks * [Api set: WordApi 1.6] @@ -101852,22 +101854,22 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param breakType Required. The break type to add to the body. - * @param insertLocation Required. The value must be 'Start' or 'End'. + * @param breakType The break type to add to the body. + * @param insertLocation The value must be `start` or `end`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): void; /** - * Wraps the Body object with a content control. + * Wraps the `Body` object with a content control. * * @remarks * [Api set: WordApi 1.1] * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. - * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. + * `dropDownList` and `comboBox` support was added in WordApi 1.9. Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. * - * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + * @param contentControlType Optional. Content control type to insert. Must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. The default is `richText`. */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl; /** * Inserts a document into the body at the specified location. * @@ -101876,8 +101878,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -101886,8 +101888,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param html Required. The HTML to be inserted in the document. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param html The HTML to be inserted in the document. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -101896,8 +101898,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted in the body. - * @param insertLocation Required. The value must be 'Start' or 'End'. + * @param base64EncodedImage The Base64-encoded image to be inserted in the body. + * @param insertLocation The value must be `start` or `end`. */ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.InlinePicture; /** @@ -101906,8 +101908,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param ooxml Required. The OOXML to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param ooxml The OOXML to be inserted. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -101916,8 +101918,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Start' or 'End'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `start` or `end`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.Paragraph; /** @@ -101926,9 +101928,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Start' or 'End'. + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `start` or `end`. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", values?: string[][]): Word.Table; @@ -101938,17 +101940,17 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param text Text to be inserted. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** - * Performs a search with the specified SearchOptions on the scope of the body object. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the `Body` object. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.1] * - * @param searchText Required. The search text. Can be a maximum of 255 characters. + * @param searchText The search text. Can be a maximum of 255 characters. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -101966,7 +101968,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -101975,7 +101977,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -102058,13 +102060,13 @@ declare namespace Word { */ untrack(): Word.Body; /** - * 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.Body` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BodyData`) 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.Body` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BodyData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BodyData; } /** - * Represents the Border object for text, a paragraph, or a table. + * Represents the `Border` object for text, a paragraph, or a table. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -102145,9 +102147,9 @@ declare namespace Word { */ untrack(): Word.Border; /** - * 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.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderData`) 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.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BorderData; } /** @@ -102253,9 +102255,9 @@ declare namespace Word { */ untrack(): Word.BorderUniversal; /** - * 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.BorderUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderUniversalData`) 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.BorderUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderUniversalData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BorderUniversalData; } /** @@ -102270,7 +102272,7 @@ declare namespace Word { /** Gets the loaded child items in this collection. */ readonly items: Word.Border[]; /** - * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * 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] @@ -102291,7 +102293,7 @@ declare namespace Word { */ 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. + * 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] @@ -102333,12 +102335,12 @@ declare namespace Word { */ getFirstOrNullObject(): Word.Border; /** - * Gets a Border object by its index in the collection. + * Gets a `Border` object by its index in the collection. * * @remarks * [Api set: WordApiDesktop 1.1] * - * @param index A number that identifies the index location of a Border object. + * @param index The location of a `Border` object. */ getItem(index: number): Word.Border; /** @@ -102368,9 +102370,9 @@ declare namespace Word { */ untrack(): Word.BorderCollection; /** - * 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.BorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.BorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.BorderCollectionData; } /** @@ -102428,9 +102430,9 @@ declare namespace Word { */ untrack(): Word.BorderUniversalCollection; /** - * 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.BorderUniversalCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderUniversalCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.BorderUniversalCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderUniversalCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.BorderUniversalCollectionData; } /** @@ -102494,9 +102496,9 @@ declare namespace Word { */ untrack(): Word.Break; /** - * 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.Break` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BreakData`) 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.Break` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BreakData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BreakData; } /** @@ -102537,9 +102539,9 @@ declare namespace Word { */ untrack(): Word.BreakCollection; /** - * 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.BreakCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BreakCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.BreakCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BreakCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.BreakCollectionData; } /** @@ -102662,9 +102664,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlock; /** - * 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.BuildingBlock` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockData`) 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.BuildingBlock` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BuildingBlockData; } /** @@ -102740,9 +102742,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockCollection; /** - * 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.BuildingBlockCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCollectionData`) 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.BuildingBlockCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -102824,9 +102826,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockEntryCollection; /** - * 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.BuildingBlockEntryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockEntryCollectionData`) 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.BuildingBlockEntryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockEntryCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -102898,9 +102900,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockCategory; /** - * 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.BuildingBlockCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCategoryData`) 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.BuildingBlockCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCategoryData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BuildingBlockCategoryData; } /** @@ -102952,9 +102954,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockCategoryCollection; /** - * 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.BuildingBlockCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCategoryCollectionData`) 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.BuildingBlockCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCategoryCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -103019,9 +103021,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockTypeItem; /** - * 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.BuildingBlockTypeItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockTypeItemData`) 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.BuildingBlockTypeItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockTypeItemData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BuildingBlockTypeItemData; } /** @@ -103082,9 +103084,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockTypeItemCollection; /** - * 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.BuildingBlockTypeItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockTypeItemCollectionData`) 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.BuildingBlockTypeItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockTypeItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -103143,9 +103145,9 @@ declare namespace Word { */ untrack(): Word.CheckboxContentControl; /** - * 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.CheckboxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CheckboxContentControlData`) 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.CheckboxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CheckboxContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CheckboxContentControlData; } /** @@ -103228,9 +103230,9 @@ declare namespace Word { */ untrack(): Word.CoauthoringLock; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CoauthoringLock` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringLockData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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.CoauthoringLock` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringLockData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CoauthoringLockData; } /** @@ -103290,9 +103292,9 @@ declare namespace Word { */ untrack(): Word.CoauthoringLockCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CoauthoringLockCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringLockCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.CoauthoringLockCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringLockCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CoauthoringLockCollectionData; } /** @@ -103400,9 +103402,9 @@ declare namespace Word { */ untrack(): Word.Coauthor; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Coauthor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthorData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Coauthor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthorData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CoauthorData; } /** @@ -103444,9 +103446,9 @@ declare namespace Word { */ untrack(): Word.CoauthorCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CoauthorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthorCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.CoauthorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthorCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CoauthorCollectionData; } /** @@ -103553,9 +103555,9 @@ declare namespace Word { */ untrack(): Word.Coauthoring; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Coauthoring` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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.Coauthoring` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CoauthoringData; } /** @@ -103614,9 +103616,9 @@ declare namespace Word { */ untrack(): Word.CoauthoringUpdate; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CoauthoringUpdate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringUpdateData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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.CoauthoringUpdate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringUpdateData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CoauthoringUpdateData; } /** @@ -103658,9 +103660,9 @@ declare namespace Word { */ untrack(): Word.CoauthoringUpdateCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CoauthoringUpdateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringUpdateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthoringUpdateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringUpdateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CoauthoringUpdateCollectionData; } /** @@ -103722,7 +103724,7 @@ declare namespace Word { */ readonly id: string; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * 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] @@ -103756,7 +103758,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param replyText Required. Reply text. + * @param replyText Reply text. */ reply(replyText: string): Word.CommentReply; /** @@ -103789,9 +103791,9 @@ declare namespace Word { */ untrack(): Word.Comment; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Comment` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Comment` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CommentData; } /** @@ -103846,12 +103848,14 @@ declare namespace Word { */ untrack(): Word.CommentCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CommentCollectionData; } /** + * Represents a content range within a comment. + * * @remarks * [Api set: WordApi 1.4] */ @@ -103859,7 +103863,7 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies whether the comment text is bold. * * @remarks * [Api set: WordApi 1.4] @@ -103880,14 +103884,14 @@ declare namespace Word { */ readonly isEmpty: boolean; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies 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. + * Specifies whether the comment text has a strikethrough. * * @remarks * [Api set: WordApi 1.4] @@ -103901,7 +103905,7 @@ declare namespace Word { */ readonly text: string; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Specifies the comment text's underline type. `none` if the comment text isn't underlined. * * @remarks * [Api set: WordApi 1.4] @@ -103921,8 +103925,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param text Required. The text to be inserted in to the CommentContentRange. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param text The text to be inserted in to the `CommentContentRange`. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange; /** @@ -103955,9 +103959,9 @@ declare namespace Word { */ untrack(): Word.CommentContentRange; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CommentContentRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CommentContentRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CommentContentRangeData; } /** @@ -104063,9 +104067,9 @@ declare namespace Word { */ untrack(): Word.CommentReply; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CommentReply` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CommentReply` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CommentReplyData; } /** @@ -104120,9 +104124,9 @@ declare namespace Word { */ untrack(): Word.CommentReplyCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CommentReplyCollectionData; } /** @@ -104229,9 +104233,9 @@ declare namespace Word { */ untrack(): Word.ConditionalStyle; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ConditionalStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConditionalStyleData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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.ConditionalStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConditionalStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ConditionalStyleData; } /** @@ -104342,9 +104346,9 @@ declare namespace Word { */ untrack(): Word.XmlMapping; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.XmlMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlMappingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.XmlMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlMappingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.XmlMappingData; } /** @@ -104404,7 +104408,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a paragraph object. + * @param index The location of a `CustomXmlPrefixMapping` object. */ getItem(index: number): Word.CustomXmlPrefixMapping; /** @@ -104452,9 +104456,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPrefixMappingCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlPrefixMappingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlPrefixMappingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlPrefixMappingCollectionData; } /** @@ -104510,9 +104514,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPrefixMapping; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlPrefixMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlPrefixMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomXmlPrefixMappingData; } /** @@ -104582,9 +104586,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlSchema; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlSchema` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlSchema` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomXmlSchemaData; } /** @@ -104629,7 +104633,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param index A number that identifies the index location of a paragraph object. + * @param index The location of a `CustomXmlSchema` object. */ getItem(index: number): Word.CustomXmlSchema; /** @@ -104673,9 +104677,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlSchemaCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlSchemaCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlSchemaCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlSchemaCollectionData; } /** @@ -104753,7 +104757,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a paragraph object. + * @param index The location of a `CustomXmlValidationError` object. */ getItem(index: number): Word.CustomXmlValidationError; /** @@ -104783,9 +104787,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlValidationErrorCollection; /** - * 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.CustomXmlValidationErrorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlValidationErrorCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.CustomXmlValidationErrorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlValidationErrorCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlValidationErrorCollectionData; } /** @@ -104909,9 +104913,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlValidationError; /** - * 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.CustomXmlValidationError` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlValidationErrorData`) 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.CustomXmlValidationError` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlValidationErrorData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomXmlValidationErrorData; } /** @@ -104939,7 +104943,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a CustomXMLNode object. + * @param index The location of a `CustomXmlNode` object. */ getItem(index: number): Word.CustomXmlNode; /** @@ -104969,9 +104973,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlNodeCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlNodeCollectionData; } /** @@ -105354,9 +105358,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlNode; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomXmlNodeData; } /** @@ -105369,42 +105373,42 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly buildingBlockGalleryContentControl: Word.BuildingBlockGalleryContentControl; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.7] */ readonly checkboxContentControl: Word.CheckboxContentControl; /** - * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * Gets the data of the content control when its type is `comboBox`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.9] */ readonly comboBoxContentControl: Word.ComboBoxContentControl; /** - * Gets the collection of content control objects in the content control. + * Gets the collection of `ContentControl` objects in the content control. * * @remarks * [Api set: WordApi 1.1] */ readonly contentControls: Word.ContentControlCollection; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly datePickerContentControl: Word.DatePickerContentControl; /** - * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + * Gets the data of the content control when its type is `dropDownList`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.9] @@ -105418,7 +105422,7 @@ declare namespace Word { */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the content control. + * Gets the collection of `Field` objects in the content control. * * @remarks * [Api set: WordApi 1.4] @@ -105439,28 +105443,28 @@ declare namespace Word { */ readonly footnotes: Word.NoteItemCollection; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly groupContentControl: Word.GroupContentControl; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * Gets the collection of `InlinePicture` objects in the content control. The collection doesn't include floating images. * * @remarks * [Api set: WordApi 1.1] */ readonly inlinePictures: Word.InlinePictureCollection; /** - * Gets the collection of list objects in the content control. + * Gets the collection of `List` objects in the content control. * * @remarks * [Api set: WordApi 1.3] */ readonly lists: Word.ListCollection; /** - * Gets the collection of paragraph objects in the content control. + * Gets the collection of `Paragraph` objects in the content control. * * @remarks * [Api set: WordApi 1.1] @@ -105518,21 +105522,21 @@ declare namespace Word { */ readonly parentTableOrNullObject: Word.Table; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly pictureContentControl: Word.PictureContentControl; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly repeatingSectionContentControl: Word.RepeatingSectionContentControl; /** - * Gets the collection of table objects in the content control. + * Gets the collection of `Table` objects in the content control. * * @remarks * [Api set: WordApi 1.3] @@ -105546,14 +105550,14 @@ declare namespace Word { */ readonly xmlMapping: Word.XmlMapping; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks * [Api set: WordApi 1.1] @@ -105588,28 +105592,28 @@ declare namespace Word { */ placeholderText: string; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ removeWhenEdited: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * 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. + * 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. + * Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. * * @remarks * [Api set: WordApi 1.3] @@ -105637,7 +105641,7 @@ declare namespace Word { */ title: string; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. * * @remarks * [Api set: WordApi 1.1] @@ -105659,12 +105663,12 @@ declare namespace Word { */ clear(): void; /** - * Deletes the content control and its content. If `keepContent` is set to true, the content isn't deleted. + * Deletes the content control and its content. If `keepContent` is set to `true`, the content isn't deleted. * * @remarks * [Api set: WordApi 1.1] * - * @param keepContent Required. Indicates whether the content should be deleted with the content control. If `keepContent` is set to true, the content isn't deleted. + * @param keepContent Indicates whether the content should be deleted with the content control. If `keepContent` is set to `true`, the content isn't deleted. */ delete(keepContent: boolean): void; /** @@ -105688,14 +105692,14 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the `ContentControl` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. * * @remarks * [Api set: WordApi 1.1] */ getHtml(): OfficeExtension.ClientResult; /** - * Gets the Office Open XML (OOXML) representation of the content control object. + * Gets the Office Open XML (OOXML) representation of the `ContentControl` object. * * @remarks * [Api set: WordApi 1.1] @@ -105707,7 +105711,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'Before', 'After', or 'Content'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `before`, `after`, or `content`. */ getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range; /** @@ -105716,7 +105720,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** @@ -105725,34 +105729,34 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Gets the text ranges in the content control by using punctuation marks and/or other ending marks. + * Gets the text ranges in the content control by using punctuation marks and other ending marks. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Gets the collection of the TrackedChange objects in the content control. + * Gets the collection of the `TrackedChange` objects in the content control. * * @remarks * [Api set: WordApi 1.6] */ getTrackedChanges(): Word.TrackedChangeCollection; /** - * Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * Inserts a break at the specified location in the main document. This method cannot be used with `richTextTable`, `richTextTableRow`, and `richTextTableCell` content controls. * * @remarks * [Api set: WordApi 1.1] * - * @param breakType Required. Type of break. - * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. + * @param breakType Type of break. + * @param insertLocation The value must be `start`, `end`, `before`, or `after`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): void; /** @@ -105763,8 +105767,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. `replace` cannot be used with `richTextTable` and `richTextTableRow` content controls. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -105773,8 +105777,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param html Required. The HTML to be inserted in to the content control. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + * @param html The HTML to be inserted in to the content control. + * @param insertLocation The value must be `replace`, `start`, or `end`. `replace` cannot be used with `richTextTable` and `richTextTableRow` content controls. */ insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -105783,8 +105787,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted in the content control. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + * @param base64EncodedImage The Base64-encoded image to be inserted in the content control. + * @param insertLocation The value must be `replace`, `start`, or `end`. `replace` cannot be used with `richTextTable` and `richTextTableRow` content controls. */ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; /** @@ -105793,8 +105797,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param ooxml Required. The OOXML to be inserted in to the content control. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + * @param ooxml The OOXML to be inserted in to the content control. + * @param insertLocation The value must be `replace`, `start`, or `end`. `replace` cannot be used with `richTextTable` and `richTextTableRow` content controls. */ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -105803,8 +105807,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `start`, `end`, `before`, or `after`. `before` and `after` cannot be used with `richTextTable`, `richTextTableRow`, and `richTextTableCell` content controls. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; /** @@ -105813,9 +105817,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `start`, `end`, `before`, or `after`. `before` and `after` cannot be used with `richTextTable`, `richTextTableRow`, and `richTextTableCell` content controls. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After", values?: string[][]): Word.Table; @@ -105825,8 +105829,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param text Required. The text to be inserted in to the content control. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + * @param text The text to be inserted in to the content control. + * @param insertLocation The value must be `replace`, `start`, or `end`. `replace` cannot be used with `richTextTable` and `richTextTableRow` content controls. */ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -105838,12 +105842,12 @@ declare namespace Word { */ resetState(): void; /** - * Performs a search with the specified SearchOptions on the scope of the content control object. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the `ContentControl` object. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.1] * - * @param searchText Required. The search text. + * @param searchText The search text. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -105861,7 +105865,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -105870,7 +105874,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -105899,10 +105903,10 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param delimiters Required. The delimiters as an array of strings. - * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters. - * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param delimiters The delimiters as an array of strings. + * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is `false` which indicates that the paragraph boundaries are also used as delimiters. + * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is `false` which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; /** @@ -106020,9 +106024,9 @@ declare namespace Word { */ untrack(): Word.ContentControl; /** - * 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.ContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlData`) 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.ContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ContentControlData; } /** @@ -106042,7 +106046,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param changeTrackingStates Required. An array of content control change tracking states. + * @param changeTrackingStates An array of content control change tracking states. */ getByChangeTrackingStates(changeTrackingStates: Word.ChangeTrackingState[]): Word.ContentControlCollection; /** @@ -106051,7 +106055,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param id Required. A content control identifier. + * @param id A content control identifier. */ getById(id: number): Word.ContentControl; /** @@ -106060,7 +106064,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param id Required. A content control identifier. + * @param id A content control identifier. */ getByIdOrNullObject(id: number): Word.ContentControl; /** @@ -106069,7 +106073,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param tag Required. A tag set on a content control. + * @param tag A tag set on a content control. */ getByTag(tag: string): Word.ContentControlCollection; /** @@ -106078,7 +106082,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param title Required. The title of a content control. + * @param title The title of a content control. */ getByTitle(title: string): Word.ContentControlCollection; /** @@ -106087,7 +106091,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param types Required. An array of content control types. + * @param types An array of content control types. */ getByTypes(types: Word.ContentControlType[]): Word.ContentControlCollection; /** @@ -106140,9 +106144,9 @@ declare namespace Word { */ untrack(): Word.ContentControlCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ContentControlCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.ContentControlCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ContentControlCollectionData; } /** @@ -106299,13 +106303,13 @@ declare namespace Word { */ interface ContentControlOptions { /** - * An array of content control types, item must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. + * An array of content control types, item must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. * * @remarks * [Api set: WordApi 1.5] * - * Note: 'PlainText' support was added in WordApi 1.5. 'CheckBox' support was added in WordApi 1.7. - * 'DropDownList' and 'ComboBox' support was added in WordApi 1.9. + * Note: `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. `dropDownList` and `comboBox` support was added in WordApi 1.9. + * Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. */ types: Word.ContentControlType[]; } @@ -106384,9 +106388,9 @@ declare namespace Word { */ untrack(): Word.CustomProperty; /** - * 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.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyData`) 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.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomPropertyData; } /** @@ -106406,8 +106410,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param key Required. The custom property's key, which is case-insensitive. - * @param value Required. The custom property's value. + * @param key The custom property's key, which is case-insensitive. + * @param value The custom property's value. */ add(key: string, value: any): Word.CustomProperty; /** @@ -106418,19 +106422,19 @@ declare namespace Word { */ deleteAll(): void; /** - * Gets the count of custom properties. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApi 1.3] */ getCount(): OfficeExtension.ClientResult; /** - * Gets a custom property object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property doesn't exist. + * Gets a `CustomProperty` object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property doesn't exist. * * @remarks * [Api set: WordApi 1.3] * - * @param key The key that identifies the custom property object. + * @param key The key that identifies the `CustomProperty` object. */ getItem(key: string): Word.CustomProperty; /** @@ -106439,7 +106443,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param key Required. The key that identifies the custom property object. + * @param key The key that identifies the custom property object. */ getItemOrNullObject(key: string): Word.CustomProperty; /** @@ -106469,9 +106473,9 @@ declare namespace Word { */ untrack(): Word.CustomPropertyCollection; /** - * 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.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomPropertyCollectionData; } /** @@ -106629,9 +106633,9 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single element in XPath notation. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". - * @param name Required. Name of the attribute. + * @param xpath Absolute path to the single element in XPath notation. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param name Name of the attribute. */ deleteAttribute(xpath: string, namespaceMappings: { [key: string]: string; @@ -106657,8 +106661,8 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single element in XPath notation. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param xpath Absolute path to the single element in XPath notation. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". */ deleteElement(xpath: string, namespaceMappings: { [key: string]: string; @@ -106691,10 +106695,10 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single element in XPath notation. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". - * @param name Required. Name of the attribute. - * @param value Required. Value of the attribute. + * @param xpath Absolute path to the single element in XPath notation. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param name Name of the attribute. + * @param value Value of the attribute. */ insertAttribute(xpath: string, namespaceMappings: { [key: string]: string; @@ -106720,9 +106724,9 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single parent element in XPath notation. - * @param xml Required. XML content to be inserted. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param xpath Absolute path to the single parent element in XPath notation. + * @param xml XML content to be inserted. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". * @param index Optional. Zero-based position at which the new XML to be inserted. If omitted, the XML will be appended as the last child of this parent. */ insertElement(xpath: string, xml: string, namespaceMappings: { @@ -106758,8 +106762,8 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. An XPath query. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param xpath An XPath query. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". * @returns An array where each item represents an entry matched by the XPath query. */ query(xpath: string, namespaceMappings: { @@ -106789,7 +106793,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param xml Required. XML content to be set. + * @param xml XML content to be set. */ setXml(xml: string): void; /** @@ -106813,10 +106817,10 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single element in XPath notation. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". - * @param name Required. Name of the attribute. - * @param value Required. New value of the attribute. + * @param xpath Absolute path to the single element in XPath notation. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param name Name of the attribute. + * @param value New value of the attribute. */ updateAttribute(xpath: string, namespaceMappings: { [key: string]: string; @@ -106842,9 +106846,9 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single element in XPath notation. - * @param xml Required. New XML content to be stored. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param xpath Absolute path to the single element in XPath notation. + * @param xml New XML content to be stored. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". */ updateElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string; @@ -106879,9 +106883,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPart; /** - * 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.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartData`) 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.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomXmlPartData; } /** @@ -106901,7 +106905,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param xml Required. XML content. Must be a valid XML fragment. + * @param xml XML content. Must be a valid XML fragment. */ add(xml: string): Word.CustomXmlPart; /** @@ -106910,7 +106914,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param namespaceUri Required. The namespace URI. + * @param namespaceUri The namespace URI. */ getByNamespace(namespaceUri: string): Word.CustomXmlPartScopedCollection; /** @@ -106935,7 +106939,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param id Required. ID of the object to be retrieved. + * @param id ID of the object to be retrieved. */ getItemOrNullObject(id: string): Word.CustomXmlPart; /** @@ -106965,9 +106969,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPartCollection; /** - * 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.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlPartCollectionData; } /** @@ -107003,7 +107007,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param id Required. ID of the object to be retrieved. + * @param id ID of the object to be retrieved. */ getItemOrNullObject(id: string): Word.CustomXmlPart; /** @@ -107047,13 +107051,13 @@ declare namespace Word { */ untrack(): Word.CustomXmlPartScopedCollection; /** - * 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.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlPartScopedCollectionData; } /** - * 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. + * 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] @@ -107091,7 +107095,7 @@ declare namespace Word { */ readonly bibliography: Word.Bibliography; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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] @@ -107146,7 +107150,7 @@ declare namespace Word { */ readonly content: Word.Range; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks * [Api set: WordApi 1.1] @@ -107275,7 +107279,7 @@ declare namespace Word { */ readonly revisions: Word.RevisionCollection; /** - * Gets the collection of section objects in the document. + * Gets the collection of `Section` objects in the document. * * @remarks * [Api set: WordApi 1.1] @@ -108058,7 +108062,7 @@ declare namespace Word { */ readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"; /** - * 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. + * 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] @@ -108151,7 +108155,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlSaveThroughXSLT: string; + xmlSaveThroughXslt: string; /** * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. @@ -108190,8 +108194,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ addStyle(name: string, type: Word.StyleType): Word.Style; /** @@ -108200,8 +108204,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; /** @@ -108308,23 +108312,23 @@ declare namespace Word { /** * Closes the current document. - Note: This API isn't supported in Word on the web. + Note: This API isn't supported in Word on the web. * * @remarks * [Api set: WordApi 1.5] * - * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. + * @param closeBehavior Optional. The close behavior must be `save` or `skipSave`. Default value is `save`. */ close(closeBehavior?: Word.CloseBehavior): void; /** * Closes the current document. - Note: This API isn't supported in Word on the web. + Note: This API isn't supported in Word on the web. * * @remarks * [Api set: WordApi 1.5] * - * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. + * @param closeBehavior Optional. The close behavior must be `save` or `skipSave`. Default value is `save`. */ close(closeBehavior?: "Save" | "SkipSave"): void; /** @@ -108341,7 +108345,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.1] * - * @param filePath Required. The path of the document with which the specified document is compared. + * @param filePath The path of the document with which the specified document is compared. * @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document. */ compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void; @@ -108351,8 +108355,8 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param base64File Required. The Base64-encoded content of the document with which the specified document is compared. - * @param documentCompareOptions Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `CompareTargetSelected` in this API. + * @param base64File The Base64-encoded content of the document with which the specified document is compared. + * @param documentCompareOptions Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `compareTargetSelected` in this API. */ compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void; /** @@ -108474,7 +108478,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param name Required. The case-insensitive bookmark name. + * @param name The case-insensitive bookmark name. */ deleteBookmark(name: string): void; /** @@ -108607,7 +108611,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param name Required. The case-insensitive bookmark name. + * @param name The case-insensitive bookmark name. */ getBookmarkRange(name: string): Word.Range; /** @@ -108616,7 +108620,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param name Required. The case-insensitive bookmark name. + * @param name The case-insensitive bookmark name. */ getBookmarkRangeOrNullObject(name: string): Word.Range; /** @@ -108672,7 +108676,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] * - * @param id Required. Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. + * @param id Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. */ getParagraphByUniqueLocalId(id: string): Word.Paragraph; /** @@ -108693,7 +108697,7 @@ declare namespace Word { */ getSelection(): Word.Range; /** - * Gets a StyleCollection object that represents the whole style set of the document. + * Gets a `StyleCollection` object that represents the whole style set of the document. * * @remarks * [Api set: WordApi 1.5] @@ -108717,8 +108721,8 @@ declare namespace Word { * * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * - * @param stylesJson Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * @param stylesJson A JSON-formatted string representing the styles. + * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. The default value is `ignore`. */ importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; /** @@ -108729,8 +108733,8 @@ declare namespace Word { * * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * - * @param stylesJson Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * @param stylesJson A JSON-formatted string representing the styles. + * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. The default value is `ignore`. */ importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult; /** @@ -108742,8 +108746,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; @@ -109010,7 +109014,7 @@ declare namespace Word { * * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. * - * @param saveBehavior Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. + * @param saveBehavior Optional. The save behavior must be `save` or `prompt`. Default value is `save`. * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; @@ -109022,7 +109026,7 @@ declare namespace Word { * * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. * - * @param saveBehavior Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. + * @param saveBehavior Optional. The save behavior must be `save` or `prompt`. Default value is `save`. * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; @@ -109037,10 +109041,13 @@ declare namespace Word { */ saveAsQuickStyleSet(fileName: string): void; /** - * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.7] + * + * @param searchText The text to search for. + * @param searchOptions Optional. Options that define how the search is performed. */ search(searchText: string, searchOptions?: Word.SearchOptions | { ignorePunct?: boolean; @@ -109375,13 +109382,13 @@ declare namespace Word { */ untrack(): Word.Document; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Document` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Document` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.DocumentData; } /** - * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. + * 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] @@ -109390,14 +109397,14 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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] */ readonly body: Word.Body; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -109418,7 +109425,7 @@ declare namespace Word { */ readonly properties: Word.DocumentProperties; /** - * Gets the collection of section objects in the document. + * Gets the collection of `Section` objects in the document. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -109432,7 +109439,7 @@ declare namespace Word { */ readonly settings: Word.SettingCollection; /** - * 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. + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -109452,8 +109459,8 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.5] * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ addStyle(name: string, type: Word.StyleType): Word.Style; /** @@ -109462,8 +109469,8 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.5] * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; /** @@ -109472,7 +109479,7 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.4] * - * @param name Required. The case-insensitive bookmark name. + * @param name The case-insensitive bookmark name. */ deleteBookmark(name: string): void; /** @@ -109481,7 +109488,7 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.4] * - * @param name Required. The case-insensitive bookmark name. + * @param name The case-insensitive bookmark name. */ getBookmarkRange(name: string): Word.Range; /** @@ -109490,7 +109497,7 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.4] * - * @param name Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + * @param name The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ getBookmarkRangeOrNullObject(name: string): Word.Range; /** @@ -109507,7 +109514,7 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets a StyleCollection object that represents the whole style set of the document. + * Gets a `StyleCollection` object that represents the whole style set of the document. * * @remarks * [Api set: WordApiHiddenDocument 1.5] @@ -109522,8 +109529,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; @@ -109542,7 +109549,7 @@ declare namespace Word { * * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. * - * @param saveBehavior Optional. DocumentCreated only supports 'Save'. + * @param saveBehavior Optional. `DocumentCreated` only supports `save`. * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; @@ -109554,7 +109561,7 @@ declare namespace Word { * * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. * - * @param saveBehavior Optional. DocumentCreated only supports 'Save'. + * @param saveBehavior Optional. `DocumentCreated` only supports `save`. * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; @@ -109588,9 +109595,9 @@ declare namespace Word { */ untrack(): Word.DocumentCreated; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentCreated` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentCreatedData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentCreated` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentCreatedData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.DocumentCreatedData; } /** @@ -109766,13 +109773,13 @@ declare namespace Word { */ untrack(): Word.DocumentProperties; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.DocumentPropertiesData; } /** - * The data specific to content controls of type DropDownList. + * The data specific to content controls of type `dropDownList`. * * @remarks * [Api set: WordApi 1.9] @@ -109793,7 +109800,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.9] * - * @param displayText Required. Display text of the list item. + * @param displayText Display text of the list item. * @param value Optional. Value of the list item. * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. */ @@ -109835,7 +109842,7 @@ declare namespace Word { toJSON(): Word.Interfaces.DropDownListContentControlData; } /** - * The data specific to content controls of type 'ComboBox'. + * The data specific to content controls of type `comboBox`. * * @remarks * [Api set: WordApi 1.9] @@ -109856,7 +109863,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.9] * - * @param displayText Required. Display text of the list item. + * @param displayText Display text of the list item. * @param value Optional. Value of the list item. * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. */ @@ -109992,7 +109999,7 @@ declare namespace Word { */ 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. + * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks * [Api set: WordApi 1.5] @@ -110085,7 +110092,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -110094,7 +110101,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -110150,9 +110157,9 @@ declare namespace Word { */ untrack(): Word.Field; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Field` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Field` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.FieldData; } /** @@ -110185,12 +110192,12 @@ declare namespace Word { */ getFirstOrNullObject(): Word.Field; /** - * Gets the Field object collection including the specified types of fields. + * Gets the `FieldCollection` object including the specified types of fields. * * @remarks * [Api set: WordApi 1.5] * - * @param types Required. An array of field types. + * @param types An array of field types. */ getByTypes(types: Word.FieldType[]): Word.FieldCollection; /** @@ -110220,9 +110227,9 @@ declare namespace Word { */ untrack(): Word.FieldCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.FieldCollectionData; } /** @@ -110304,7 +110311,7 @@ declare namespace Word { */ allCaps: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -110324,7 +110331,7 @@ declare namespace Word { */ boldBidirectional: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApi 1.1] @@ -110366,7 +110373,7 @@ declare namespace Word { */ 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. + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -110406,21 +110413,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hidden: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * 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. + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -110454,7 +110461,7 @@ declare namespace Word { */ 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. + * Specifies the name of the font. * * @remarks * [Api set: WordApi 1.1] @@ -110543,7 +110550,7 @@ declare namespace Word { */ shadow: boolean; /** - * Specifies a value that represents the font size in points. + * Specifies the font size in points. * * @remarks * [Api set: WordApi 1.1] @@ -110577,7 +110584,7 @@ declare namespace Word { */ spacing: number; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -110591,21 +110598,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ subscript: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ superscript: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies the font's underline type. `none` if the font isn't underlined. * * @remarks * [Api set: WordApi 1.1] @@ -110684,9 +110691,9 @@ declare namespace Word { */ untrack(): Word.Font; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.FontData; } /** @@ -110761,9 +110768,9 @@ declare namespace Word { */ untrack(): Word.HeadingStyle; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.HeadingStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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.HeadingStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.HeadingStyleData; } /** @@ -110817,9 +110824,9 @@ declare namespace Word { */ untrack(): Word.HeadingStyleCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.HeadingStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.HeadingStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.HeadingStyleCollectionData; } /** @@ -110922,9 +110929,9 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param fileName Required. The name of the file. - * @param editNow Required. `true` to start editing now. - * @param overwrite Required. `true` to overwrite if there's another file with the same name. + * @param fileName The name of the file. + * @param editNow `true` to start editing now. + * @param overwrite `true` to overwrite if there's another file with the same name. */ createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void; /** @@ -110964,9 +110971,9 @@ declare namespace Word { */ untrack(): Word.Hyperlink; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.HyperlinkData; } /** @@ -110986,7 +110993,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param anchor Required. The range to which the hyperlink is added. + * @param anchor The range to which the hyperlink is added. * @param options Optional. The options to further configure the new hyperlink. */ add(anchor: Word.Range, options?: Word.HyperlinkAddOptions): Word.Hyperlink; @@ -111017,9 +111024,9 @@ declare namespace Word { */ untrack(): Word.HyperlinkCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.HyperlinkCollectionData; } /** @@ -111214,7 +111221,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, or `end`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** @@ -111223,8 +111230,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param breakType Required. The break type to add. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param breakType The break type to add. + * @param insertLocation The value must be `before` or `after`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** @@ -111242,8 +111249,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `before` or `after`. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** @@ -111252,8 +111259,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param html Required. The HTML to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param html The HTML to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** @@ -111262,8 +111269,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'. + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertLocation The value must be `replace`, `before`, or `after`. */ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture; /** @@ -111272,8 +111279,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param ooxml Required. The OOXML to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param ooxml The OOXML to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** @@ -111282,8 +111289,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** @@ -111292,8 +111299,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param text Text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** @@ -111302,7 +111309,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -111311,7 +111318,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -111344,9 +111351,9 @@ declare namespace Word { */ untrack(): Word.InlinePicture; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.InlinePicture` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.InlinePicture` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.InlinePictureData; } /** @@ -111401,9 +111408,9 @@ declare namespace Word { */ untrack(): Word.InlinePictureCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.InlinePictureCollectionData; } /** @@ -111518,9 +111525,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -111540,21 +111547,21 @@ declare namespace Word { */ readonly paragraphs: Word.ParagraphCollection; /** - * Gets the list's id. + * Gets the list's ID. * * @remarks * [Api set: WordApi 1.3] */ readonly id: 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. + * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks * [Api set: WordApi 1.3] */ readonly levelExistences: boolean[]; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. * * @remarks * [Api set: WordApi 1.3] @@ -111566,7 +111573,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.1] * - * @param level Required. The level in the list. + * @param level The level in the list. */ getLevelFont(level: number): Word.Font; /** @@ -111575,7 +111582,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. + * @param level The level in the list. */ getLevelParagraphs(level: number): Word.ParagraphCollection; /** @@ -111584,7 +111591,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.1] * - * @param level Required. The level in the list. + * @param level The level in the list. */ getLevelPicture(level: number): OfficeExtension.ClientResult; /** @@ -111593,7 +111600,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. + * @param level The level in the list. */ getLevelString(level: number): OfficeExtension.ClientResult; /** @@ -111602,8 +111609,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `start`, `end`, `before`, or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; /** @@ -111612,8 +111619,8 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.1] * - * @param level Required. The level in the list. - * @param resetFontName Optional. Indicates whether to reset the font name. Default is false that indicates the font name is kept unchanged. + * @param level The level in the list. + * @param resetFontName Optional. Indicates whether to reset the font name. Default is `false` that indicates the font name remains unchanged. */ resetLevelFont(level: number, resetFontName?: boolean): void; /** @@ -111622,8 +111629,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'. + * @param level The level in the list. + * @param alignment The level alignment that must be `left`, `centered`, or `right`. */ setLevelAlignment(level: number, alignment: Word.Alignment): void; /** @@ -111632,32 +111639,32 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'. + * @param level The level in the list. + * @param alignment The level alignment that must be `left`, `centered`, or `right`. */ setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void; /** - * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. + * Sets the bullet format at the specified level in the list. If the bullet is `custom`, the `charCode` is required. * * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param listBullet Required. The bullet. - * @param charCode Optional. The bullet character's code value. Used only if the bullet is 'Custom'. - * @param fontName Optional. The bullet's font name. Used only if the bullet is 'Custom'. + * @param level The level in the list. + * @param listBullet The bullet. + * @param charCode Optional. The bullet character's code value. Used only if the bullet is `custom`. + * @param fontName Optional. The bullet's font name. Used only if the bullet is `custom`. */ setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void; /** - * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. + * Sets the bullet format at the specified level in the list. If the bullet is `custom`, the `charCode` is required. * * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param listBullet Required. The bullet. - * @param charCode Optional. The bullet character's code value. Used only if the bullet is 'Custom'. - * @param fontName Optional. The bullet's font name. Used only if the bullet is 'Custom'. + * @param level The level in the list. + * @param listBullet The bullet. + * @param charCode Optional. The bullet character's code value. Used only if the bullet is `custom`. + * @param fontName Optional. The bullet's font name. Used only if the bullet is `custom`. */ setLevelBullet(level: number, listBullet: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void; /** @@ -111666,9 +111673,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param textIndent Required. The text indent in points. It is the same as paragraph left indent. - * @param bulletNumberPictureIndent Required. The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. + * @param level The level in the list. + * @param textIndent The text indent in points. It is the same as paragraph left indent. + * @param bulletNumberPictureIndent The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. */ setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; /** @@ -111677,9 +111684,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param listNumbering Required. The ordinal format. - * @param formatString Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. + * @param level The level in the list. + * @param listNumbering The ordinal format. + * @param formatString Optional. The numbering string format defined as an array of strings or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array): void; /** @@ -111688,9 +111695,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param listNumbering Required. The ordinal format. - * @param formatString Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. + * @param level The level in the list. + * @param listNumbering The ordinal format. + * @param formatString Optional. The numbering string format defined as an array of strings or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array): void; /** @@ -111699,7 +111706,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.1] * - * @param level Required. The level in the list. + * @param level The level in the list. * @param base64EncodedImage Optional. The Base64-encoded image to be set. If not given, the default picture is set. */ setLevelPicture(level: number, base64EncodedImage?: string): void; @@ -111709,8 +111716,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param startingNumber Required. The number to start with. + * @param level The level in the list. + * @param startingNumber The number to start with. */ setLevelStartingNumber(level: number, startingNumber: number): void; /** @@ -111743,9 +111750,9 @@ declare namespace Word { */ untrack(): Word.List; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.List` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.List` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListData; } /** @@ -111765,7 +111772,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param id Required. A list identifier. + * @param id A list identifier. */ getById(id: number): Word.List; /** @@ -111774,7 +111781,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param id Required. A list identifier. + * @param id A list identifier. */ getByIdOrNullObject(id: number): Word.List; /** @@ -111792,7 +111799,7 @@ declare namespace Word { */ getFirstOrNullObject(): Word.List; /** - * Gets a list object by its ID. + * Gets a `List` object by its ID. * * @remarks * [Api set: WordApi 1.3] @@ -111827,9 +111834,9 @@ declare namespace Word { */ untrack(): Word.ListCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ListCollectionData; } /** @@ -111876,7 +111883,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. + * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is `false` that specifies to get the lowest ancestor. */ getAncestor(parentOnly?: boolean): Word.Paragraph; /** @@ -111885,7 +111892,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. + * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is `false` that specifies to get the lowest ancestor. */ getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph; /** @@ -111894,7 +111901,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param directChildrenOnly Optional. Specifies only the list item's direct children will be returned. The default is false that indicates to get all descendant items. + * @param directChildrenOnly Optional. Specifies only the list item's direct children will be returned. The default is `false` that indicates to get all descendant items. */ getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection; /** @@ -111927,9 +111934,9 @@ declare namespace Word { */ untrack(): Word.ListItem; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListItemData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListItemData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListItemData; } /** @@ -111942,77 +111949,77 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets a Font object that represents the character formatting of the specified object. + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ readonly font: Word.Font; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * 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. + * Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ linkedStyle: string; /** - * Specifies the number format for the specified list level. + * Specifies the number format for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberFormat: string; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberPosition: number; /** - * Specifies the number style for the list level object. + * Specifies the number style for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the list level that must appear before it restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ resetOnHigher: number; /** - * Specifies the starting number for the specified list level object. + * Specifies the starting number for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ startAt: number; /** - * Specifies the tab position for the specified list level object. + * Specifies the tab position for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ tabPosition: number; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ textPosition: number; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the character inserted after the number for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -112056,9 +112063,9 @@ declare namespace Word { */ untrack(): Word.ListLevel; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListLevel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListLevel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListLevelData; } /** @@ -112113,9 +112120,9 @@ declare namespace Word { */ untrack(): Word.ListLevelCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListLevelCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListLevelCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ListLevelCollectionData; } /** @@ -112187,9 +112194,9 @@ declare namespace Word { */ untrack(): Word.ListTemplate; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListTemplate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListTemplateData; } /** @@ -112281,9 +112288,9 @@ declare namespace Word { */ untrack(): Word.NoteItem; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.NoteItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.NoteItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.NoteItemData; } /** @@ -112338,9 +112345,9 @@ declare namespace Word { */ untrack(): Word.NoteItemCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.NoteItemCollectionData; } /** @@ -112517,9 +112524,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -112579,7 +112586,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, or `end`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** @@ -112612,13 +112619,13 @@ declare namespace Word { */ untrack(): Word.Page; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.PageData; } /** - * Represents the collection of page. + * Represents the collection of {@link Word.Page} objects. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -112669,9 +112676,9 @@ declare namespace Word { */ untrack(): Word.PageCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.PageCollectionData; } /** @@ -112749,13 +112756,13 @@ declare namespace Word { */ untrack(): Word.Pane; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.PaneData; } /** - * Represents the collection of pane. + * Represents the collection of {@link Word.Pane} objects. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -112806,9 +112813,9 @@ declare namespace Word { */ untrack(): Word.PaneCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.PaneCollectionData; } /** @@ -113036,7 +113043,7 @@ declare namespace Word { */ isDocumentMapVisible: boolean; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -113218,7 +113225,7 @@ declare namespace Word { * [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. + * @param options Optional. The options that define whether to save changes before closing and whether to route the document. */ close(options?: Word.WindowCloseOptions): void; /** @@ -113228,7 +113235,7 @@ declare namespace Word { * [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. + * @param options Optional. The options for scrolling the window by the specified number of screens. If no options are specified, the window is scrolled down one screen. */ largeScroll(options?: Word.WindowScrollOptions): void; /** @@ -113238,7 +113245,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param options The options for scrolling through the window page by page. + * @param options Optional. The options for scrolling through the window page by page. */ pageScroll(options?: Word.WindowPageScrollOptions): void; /** @@ -113256,7 +113263,7 @@ declare namespace Word { * [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. + * @param options Optional. The options for scrolling the window by the specified number of lines. If no options are specified, the window is scrolled down by one line. */ smallScroll(options?: Word.WindowScrollOptions): void; /** @@ -113297,13 +113304,13 @@ declare namespace Word { */ untrack(): Word.Window; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.WindowData; } /** - * Represents the collection of window objects. + * Represents the collection of {@link Word.Window} objects. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -113354,9 +113361,9 @@ declare namespace Word { */ untrack(): Word.WindowCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.WindowCollectionData; } /** @@ -113376,7 +113383,7 @@ declare namespace Word { */ readonly borders: Word.BorderUniversalCollection; /** - * Gets the collection of content control objects in the paragraph. + * Gets the collection of `ContentControl` objects in the paragraph. * * @remarks * [Api set: WordApi 1.1] @@ -113411,7 +113418,7 @@ declare namespace Word { */ readonly footnotes: Word.NoteItemCollection; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * Gets the collection of `InlinePicture` objects in the paragraph. The collection doesn't include floating images. * * @remarks * [Api set: WordApi 1.1] @@ -113502,14 +113509,16 @@ declare namespace Word { */ readonly shading: Word.ShadingUniversal; /** - * 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. + * Gets the collection of `Shape` objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. */ readonly shapes: Word.ShapeCollection; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.1] @@ -113641,12 +113650,12 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param listId Required. The ID of an existing list. - * @param level Required. The level in the list. + * @param listId The ID of an existing list. + * @param level The level in the list. */ attachToList(listId: number, level: number): Word.List; /** - * Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content. + * Clears the contents of the `Paragraph` object. The user can perform the undo operation on the cleared content. * * @remarks * [Api set: WordApi 1.1] @@ -113675,7 +113684,7 @@ declare namespace Word { */ detachFromList(): void; /** - * Gets annotations set on this Paragraph object. + * Gets annotations set on this `Paragraph` object. * * @remarks * [Api set: WordApi 1.7] @@ -113704,7 +113713,7 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the `Paragraph` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. * * @remarks * [Api set: WordApi 1.1] @@ -113725,7 +113734,7 @@ declare namespace Word { */ getNextOrNullObject(): Word.Paragraph; /** - * Gets the Office Open XML (OOXML) representation of the paragraph object. + * Gets the Office Open XML (OOXML) representation of the `Paragraph` object. * * @remarks * [Api set: WordApi 1.1] @@ -113751,25 +113760,25 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `after`, or `content`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; /** - * Gets reviewed text based on ChangeTrackingVersion selection. + * Gets reviewed text based on `ChangeTrackingVersion` selection. * * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** - * Gets reviewed text based on ChangeTrackingVersion selection. + * Gets reviewed text based on `ChangeTrackingVersion` selection. * * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** @@ -113786,17 +113795,17 @@ declare namespace Word { IncludeTextMarkedAsDeleted?: boolean; }): OfficeExtension.ClientResult; /** - * Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks. + * Gets the text ranges in the paragraph by using punctuation marks and other ending marks. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Gets the collection of the TrackedChange objects in the paragraph. + * Gets the collection of the `TrackedChange` objects in the paragraph. * * @remarks * [Api set: WordApi 1.6] @@ -113831,7 +113840,7 @@ declare namespace Word { */ indentFirstLineCharacterWidth(count: number): void; /** - * Inserts annotations on this Paragraph object. + * Inserts annotations on this `Paragraph` object. * * @remarks * [Api set: WordApi 1.7] @@ -113848,8 +113857,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param breakType Required. The break type to add to the document. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param breakType The break type to add to the document. + * @param insertLocation The value must be `before` or `after`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** @@ -113862,17 +113871,17 @@ declare namespace Word { */ insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Wraps the Paragraph object with a content control. + * Wraps the `Paragraph` object with a content control. * * @remarks * [Api set: WordApi 1.1] * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. - * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. + * `dropDownList` and `comboBox` support was added in WordApi 1.9. Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. * - * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + * @param contentControlType Optional. Content control type to insert. Must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. The default is `richText`. */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl; /** * Inserts a document into the paragraph at the specified location. * @@ -113881,8 +113890,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -113911,8 +113920,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param html Required. The HTML to be inserted in the paragraph. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param html The HTML to be inserted in the paragraph. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -113921,8 +113930,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; /** @@ -113931,8 +113940,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param ooxml Required. The OOXML to be inserted in the paragraph. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param ooxml The OOXML to be inserted in the paragraph. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -113941,8 +113950,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** @@ -113951,7 +113960,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. + * @param base64EncodedImage The Base64-encoded image to be inserted. * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. */ insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; @@ -113961,9 +113970,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `before` or `after`. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; @@ -113973,8 +113982,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param text Text to be inserted. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -114080,12 +114089,12 @@ declare namespace Word { */ 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. + * Performs a search with the specified search options on the scope of the `Paragraph` object. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.1] * - * @param searchText Required. The search text. + * @param searchText The search text. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -114103,7 +114112,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -114112,7 +114121,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -114161,9 +114170,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param delimiters Required. The delimiters as an array of strings. - * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param delimiters The delimiters as an array of strings. + * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is `false` which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; /** @@ -114273,9 +114282,9 @@ declare namespace Word { */ untrack(): Word.Paragraph; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Paragraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Paragraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ParagraphData; } /** @@ -114498,9 +114507,9 @@ declare namespace Word { */ untrack(): Word.ParagraphCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ParagraphCollectionData; } /** @@ -114648,9 +114657,9 @@ declare namespace Word { */ untrack(): Word.ParagraphFormat; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ParagraphFormatData; } /** @@ -114687,7 +114696,7 @@ declare namespace Word { */ readonly conflicts: Word.ConflictCollection; /** - * Gets the collection of content control objects in the range. + * Gets the collection of `ContentControl` objects in the range. * * @remarks * [Api set: WordApi 1.1] @@ -114709,7 +114718,7 @@ declare namespace Word { */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the range. + * Gets the collection of `Field` objects in the range. * * @remarks * [Api set: WordApi 1.4] @@ -114744,7 +114753,7 @@ declare namespace Word { */ readonly hyperlinks: Word.HyperlinkCollection; /** - * Gets the collection of inline picture objects in the range. + * Gets the collection of `InlinePicture` objects in the range. * * @remarks * [Api set: WordApi 1.2] @@ -114758,7 +114767,7 @@ declare namespace Word { */ readonly listFormat: Word.ListFormat; /** - * Gets the collection of list objects in the range. + * Gets the collection of `List` objects in the range. * * @remarks * [Api set: WordApi 1.3] @@ -114772,7 +114781,7 @@ declare namespace Word { */ readonly pages: Word.PageCollection; /** - * Gets the collection of paragraph objects in the range. + * Gets the collection of `Paragraph` objects in the range. * * @remarks * [Api set: WordApi 1.1] @@ -114852,10 +114861,12 @@ declare namespace Word { */ readonly shading: Word.ShadingUniversal; /** - * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Gets the 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: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. */ readonly shapes: Word.ShapeCollection; /** @@ -114866,7 +114877,7 @@ declare namespace Word { */ readonly tableColumns: Word.TableColumnCollection; /** - * Gets the collection of table objects in the range. + * Gets the collection of `Table` objects in the range. * * @remarks * [Api set: WordApi 1.3] @@ -115151,7 +115162,7 @@ declare namespace Word { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Word.Range): void; /** - * Clears the contents of the range object. The user can perform the undo operation on the cleared content. + * Clears the contents of the `Range` object. The user can perform the undo operation on the cleared content. * * @remarks * [Api set: WordApi 1.1] @@ -115163,7 +115174,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param range Required. The range to compare with this range. + * @param range The range to compare with this range. */ compareLocationWith(range: Word.Range): OfficeExtension.ClientResult; /** @@ -115186,7 +115197,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param range Required. Another range. + * @param range Another range. */ expandTo(range: Word.Range): Word.Range; /** @@ -115195,7 +115206,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param range Required. Another range. + * @param range Another range. */ expandToOrNullObject(range: Word.Range): Word.Range; /** @@ -115204,8 +115215,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param includeHidden Optional. Indicates whether to include hidden bookmarks. Default is false which indicates that the hidden bookmarks are excluded. - * @param includeAdjacent Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is false which indicates that the adjacent bookmarks are excluded. + * @param includeHidden Optional. Indicates whether to include hidden bookmarks. Default is `false` which indicates that the hidden bookmarks are excluded. + * @param includeAdjacent Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is `false` which indicates that the adjacent bookmarks are excluded. */ getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult; /** @@ -115213,7 +115224,7 @@ declare namespace Word { * * @remarks * [Api set: WordApi 1.4] - * @returns + * @returns A `CommentCollection` object that contains all the comments associated with the range. */ getComments(): Word.CommentCollection; /** @@ -115230,7 +115241,7 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the `Range` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. * * @remarks * [Api set: WordApi 1.1] @@ -115244,39 +115255,39 @@ declare namespace Word { */ getHyperlinkRanges(): Word.RangeCollection; /** - * Gets the next text range by using punctuation marks and/or other ending marks. Throws an `ItemNotFound` error if this text range is the last one. + * Gets the next text range by using punctuation marks and other ending marks. Throws an `ItemNotFound` error if this text range is the last one. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is `false` which indicates that spacing characters at the start and end of the range are included. */ getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range; /** - * Gets the next text range by using punctuation marks and/or other ending marks. If this text range is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the next text range by using punctuation marks and other ending marks. If this text range is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is `false` which indicates that spacing characters at the start and end of the range are included. */ getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range; /** - * Gets the OOXML representation of the range object. + * Gets the OOXML representation of the `Range` object. * * @remarks * [Api set: WordApi 1.1] */ getOoxml(): OfficeExtension.ClientResult; /** - * Clones the range, or gets the starting or ending point of the range as a new range. + * Clones the `Range` object, or gets the starting or ending point of the range as a new range. * * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `after`, or `content`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; /** @@ -115285,7 +115296,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** @@ -115294,21 +115305,21 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Gets the text child ranges in the range by using punctuation marks and/or other ending marks. + * Gets the text child ranges in the range by using punctuation marks and other ending marks. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Gets the collection of the TrackedChange objects in the range. + * Gets the collection of the `TrackedChange` objects in the range. * * @remarks * [Api set: WordApi 1.6] @@ -115316,7 +115327,7 @@ declare namespace Word { getTrackedChanges(): Word.TrackedChangeCollection; /** * Highlights the range temporarily without changing document content. - To highlight the text permanently, set the range's Font.HighlightColor. + To highlight the text permanently, set the range's `font.highlightColor`. * * @remarks * [Api set: WordApi 1.8] @@ -115330,7 +115341,7 @@ declare namespace Word { * * Note: The conditions of inserting a bookmark are similar to doing so in the Word UI. To learn more about managing bookmarks in the Word UI, see {@link https://support.microsoft.com/office/f68d781f-0150-4583-a90e-a4009d99c2a0 | Add or delete bookmarks in a Word document or Outlook message}. * - * @param name Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + * @param name The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ insertBookmark(name: string): void; /** @@ -115339,8 +115350,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param breakType Required. The break type to add. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param breakType The break type to add. + * @param insertLocation The value must be `before` or `after`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** @@ -115358,22 +115369,22 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param commentText Required. The comment text to be inserted. - * @returns comment object + * @param commentText The comment text to be inserted. + * @returns The `Comment` object that was inserted. */ insertComment(commentText: string): Word.Comment; /** - * Wraps the Range object with a content control. + * Wraps the `Range` object with a content control. * * @remarks * [Api set: WordApi 1.1] * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. - * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. + * `dropDownList` and `comboBox` support was added in WordApi 1.9. Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. * - * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + * @param contentControlType Optional. Content control type to insert. Must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. The default is `richText`. */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl; /** * Inserts an endnote. The endnote reference is placed after the range. * @@ -115390,10 +115401,10 @@ declare namespace Word { * [Api set: WordApi 1.5] * * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. - * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. * - * @param insertLocation Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. - * @param fieldType Optional. Can be any FieldType constant. The default value is Empty. + * @param insertLocation The location relative to the range where the field will be inserted. The value must be `replace`, `start`, `end`, `before`, or `after`. + * @param fieldType Optional. Can be any `FieldType` value. The default value is `empty`. * @param text Optional. Additional properties or options if needed for specified field type. * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. */ @@ -115405,10 +115416,10 @@ declare namespace Word { * [Api set: WordApi 1.5] * * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. - * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. * - * @param insertLocation Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. - * @param fieldType Optional. Can be any FieldType constant. The default value is Empty. + * @param insertLocation The location relative to the range where the field will be inserted. The value must be `replace`, `start`, `end`, `before`, or `after`. + * @param fieldType Optional. Can be any `FieldType` value. The default value is `empty`. * @param text Optional. Additional properties or options if needed for specified field type. * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. */ @@ -115421,8 +115432,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** @@ -115460,8 +115471,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param html Required. The HTML to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param html The HTML to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** @@ -115470,8 +115481,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture; /** @@ -115480,8 +115491,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param ooxml Required. The OOXML to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param ooxml The OOXML to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** @@ -115490,8 +115501,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** @@ -115500,8 +115511,8 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertShapeOptions Required. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. */ insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** @@ -115510,9 +115521,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `before` or `after`. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; @@ -115522,8 +115533,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param text Text to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** @@ -115542,7 +115553,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param range Required. Another range. + * @param range Another range. */ intersectWith(range: Word.Range): Word.Range; /** @@ -115551,23 +115562,23 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param range Required. Another range. + * @param range Another range. */ intersectWithOrNullObject(range: Word.Range): Word.Range; /** - * Removes the highlight added by the Highlight function if any. + * Removes the highlight added by the `highlight` method if any. * * @remarks * [Api set: WordApi 1.8] */ removeHighlight(): void; /** - * Performs a search with the specified SearchOptions on the scope of the range object. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the `Range` object. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.1] * - * @param searchText Required. The search text. + * @param searchText The search text. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -115585,7 +115596,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -115594,7 +115605,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -115603,10 +115614,10 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param delimiters Required. The delimiters as an array of strings. - * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters. - * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param delimiters The delimiters as an array of strings. + * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is `false` which indicates that the paragraph boundaries are also used as delimiters. + * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is `false` which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; /** @@ -115679,9 +115690,9 @@ declare namespace Word { */ untrack(): Word.Range; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Range` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Range` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.RangeData; } /** @@ -115736,9 +115747,9 @@ declare namespace Word { */ untrack(): Word.RangeCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.RangeCollectionData; } /** @@ -115749,28 +115760,28 @@ declare namespace Word { */ interface InsertShapeOptions { /** - * Represents the height of the shape being inserted. + * If provided, specifies the height of the shape being inserted. * * @remarks * [Api set: WordApiDesktop 1.2] */ height?: number; /** - * Represents the left position of the shape being inserted. + * If provided, specifies the left position of the shape being inserted. * * @remarks * [Api set: WordApiDesktop 1.2] */ left?: number; /** - * Represents the top position of the shape being inserted. + * If provided, specifies the top position of the shape being inserted. * * @remarks * [Api set: WordApiDesktop 1.2] */ top?: number; /** - * Represents the width of the shape being inserted. + * If provided, specifies the width of the shape being inserted. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -115785,56 +115796,56 @@ declare namespace Word { */ interface InsertFileOptions { /** - * Represents whether the change tracking mode status from the source document should be imported. + * If provided, specifies whether the change tracking mode status from the source document should be imported. * * @remarks * [Api set: WordApi 1.5] */ importChangeTrackingMode?: boolean; /** - * Represents whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. + * If provided, specifies whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. * * @remarks * [Api set: WordApi 1.6] */ importCustomProperties?: boolean; /** - * Represents whether the custom XML parts from the source document should be imported. + * If provided, specifies whether the custom XML parts from the source document should be imported. * * @remarks * [Api set: WordApi 1.6] */ importCustomXmlParts?: boolean; /** - * Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document. + * If provided, specifies whether to import the Different Odd and Even Pages setting for the header and footer from the source document. * * @remarks * [Api set: WordApi 1.7] */ importDifferentOddEvenPages?: boolean; /** - * Represents whether the page color and other background information from the source document should be imported. + * If provided, specifies whether the page color and other background information from the source document should be imported. * * @remarks * [Api set: WordApi 1.5] */ importPageColor?: boolean; /** - * Represents whether the paragraph spacing from the source document should be imported. + * If provided, specifies whether the paragraph spacing from the source document should be imported. * * @remarks * [Api set: WordApi 1.5] */ importParagraphSpacing?: boolean; /** - * Represents whether the styles from the source document should be imported. + * If provided, specifies whether the styles from the source document should be imported. * * @remarks * [Api set: WordApi 1.5] */ importStyles?: boolean; /** - * Represents whether the theme from the source document should be imported. + * If provided, specifies whether the theme from the source document should be imported. * * @remarks * [Api set: WordApi 1.5] @@ -115852,49 +115863,49 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies a 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. + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignorePunct: boolean; /** - * 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. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignoreSpace: boolean; /** - * 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. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchCase: boolean; /** - * 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. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchPrefix: boolean; /** - * 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. + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchSuffix: boolean; /** - * 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. + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchWholeWord: boolean; /** - * 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. + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] @@ -115934,27 +115945,27 @@ declare namespace Word { */ static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SearchOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SearchOptionsData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SearchOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SearchOptionsData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.SearchOptionsData; } /** - * Specifies the options to be included in a getText operation. + * Specifies the options to be included in a {@link Word.Paragraph | Paragraph.getText} operation. * * @remarks * [Api set: WordApi 1.7] */ interface GetTextOptions { /** - * Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False. + * If provided, specifies whether to include hidden text in the result of the `Paragraph.getText` method. The default value is `false`. * * @remarks * [Api set: WordApi 1.7] */ includeHiddenText?: boolean; /** - * Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False. + * If provided, specifies whether to include text marked as deleted in the result of the `Paragraph.getText` method. The default value is `false`. * * @remarks * [Api set: WordApi 1.7] @@ -115969,50 +115980,50 @@ declare namespace Word { */ interface DocumentCompareOptions { /** - * True adds the document to the list of recently used files on the File menu. The default value is True. + * If provided, specifies whether to add the document to the list of recently used files on the **File** menu. The default value is `true`. * * @remarks * [Api set: WordApiDesktop 1.1] */ addToRecentFiles?: boolean; /** - * The reviewer name associated with the differences generated by the comparison. - If unspecified, the value defaults to the author name of the revised document or the string "Comparison" if no author information is present. + * If provided, specifies the reviewer name associated with the differences generated by the comparison. + If unspecified, the value defaults to the author name of the revised document or the string `Comparison` if no author information is present. * * @remarks * [Api set: WordApiDesktop 1.1] */ authorName?: string; /** - * The target document for the comparison. Default value is 'CompareTargetCurrent'. + * If provided, specifies the target document for the comparison. Default value is `compareTargetCurrent`. * * @remarks * [Api set: WordApiDesktop 1.1] */ compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"; /** - * True (default) for the comparison to include detection of format changes. + * If provided, specifies whether the comparison should include detection of format changes. The default value is `true`. * * @remarks * [Api set: WordApiDesktop 1.1] */ detectFormatChanges?: boolean; /** - * True compares the documents without notifying a user of problems. The default value is False. + * If provided, specifies whether to compare the documents without notifying a user of problems. The default value is `false`. * * @remarks * [Api set: WordApiDesktop 1.1] */ ignoreAllComparisonWarnings?: boolean; /** - * True removes date and time stamp information from tracked changes in the returned Document object. The default value is False. + * If provided, specifies whether to remove date and time stamp information from tracked changes in the returned `Document` object. The default value is `false`. * * @remarks * [Api set: WordApiDesktop 1.1] */ removeDateAndTime?: boolean; /** - * True removes all user information from comments, revisions, and the properties dialog box in the returned Document object. The default value is False. + * If provided, specifies whether to remove all user information from comments, revisions, and the properties dialog box in the returned `Document` object. The default value is `false`. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -116029,7 +116040,7 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. * * @remarks * [Api set: WordApi 1.1] @@ -116070,7 +116081,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * @param type The type of footer to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ getFooter(type: Word.HeaderFooterType): Word.Body; /** @@ -116079,7 +116090,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * @param type The type of footer to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; /** @@ -116088,7 +116099,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * @param type The type of header to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ getHeader(type: Word.HeaderFooterType): Word.Body; /** @@ -116097,7 +116108,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * @param type The type of header to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; /** @@ -116144,9 +116155,9 @@ declare namespace Word { */ untrack(): Word.Section; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Section` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Section` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.SectionData; } /** @@ -116201,9 +116212,9 @@ declare namespace Word { */ untrack(): Word.SectionCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.SectionCollectionData; } /** @@ -116274,9 +116285,9 @@ declare namespace Word { */ untrack(): Word.Setting; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Setting` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Setting` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.SettingData; } /** @@ -116296,8 +116307,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param key Required. The setting's key, which is case-sensitive. - * @param value Required. The setting's value. + * @param key The setting's key, which is case-sensitive. + * @param value The setting's value. */ add(key: string, value: any): Word.Setting; /** @@ -116308,28 +116319,28 @@ declare namespace Word { */ deleteAll(): void; /** - * Gets the count of settings. + * Gets the number of items in the collection. * * @remarks * [Api set: WordApi 1.4] */ getCount(): OfficeExtension.ClientResult; /** - * Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. + * Gets a `Setting` object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. * * @remarks * [Api set: WordApi 1.4] * - * @param key The key that identifies the setting object. + * @param key The key that identifies the `Setting` object. */ getItem(key: string): Word.Setting; /** - * Gets a setting object by its key, which is case-sensitive. If the setting doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets a `Setting` object by its key, which is case-sensitive. If the setting doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.4] * - * @param key Required. The key that identifies the setting object. + * @param key The key that identifies the `Setting` object. */ getItemOrNullObject(key: string): Word.Setting; /** @@ -116359,9 +116370,9 @@ declare namespace Word { */ untrack(): Word.SettingCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.SettingCollectionData; } /** @@ -116376,12 +116387,12 @@ declare namespace Word { /** Gets the loaded child items in this collection. */ readonly items: Word.Style[]; /** - * Get the style object by its name. + * Get the `Style` object by its name. * * @remarks * [Api set: WordApi 1.5] * - * @param name Required. The style name. + * @param name The style name. */ getByName(name: string): Word.Style; /** @@ -116390,23 +116401,23 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param name Required. The style name. + * @param name The style name. */ getByNameOrNullObject(name: string): Word.Style; /** - * Gets the number of the styles in the collection. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApi 1.5] */ getCount(): OfficeExtension.ClientResult; /** - * Gets a style object by its index in the collection. + * Gets a `Style` object by its index in the collection. * * @remarks * [Api set: WordApi 1.5] * - * @param index A number that identifies the index location of a style object. + * @param index The location of a `Style` object. */ getItem(index: number): Word.Style; /** @@ -116436,9 +116447,9 @@ declare namespace Word { */ untrack(): Word.StyleCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.StyleCollectionData; } /** @@ -116451,14 +116462,14 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Specifies a `BorderCollection` object that represents all the borders for the style. * * @remarks * [Api set: WordApiDesktop 1.1] */ readonly borders: Word.BorderCollection; /** - * Gets a font object that represents the character formatting of the specified style. + * Gets a `Font` object that represents the character formatting of the style. * * @remarks * [Api set: WordApi 1.5] @@ -116479,28 +116490,28 @@ declare namespace Word { */ linkStyle: Word.Style; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Gets a `ListTemplate` object that represents the list formatting for the style. * * @remarks * [Api set: WordApiDesktop 1.1] */ readonly listTemplate: Word.ListTemplate; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. * * @remarks * [Api set: WordApi 1.5] */ readonly paragraphFormat: Word.ParagraphFormat; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. * * @remarks * [Api set: WordApi 1.6] */ readonly shading: Word.Shading; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Gets a `TableStyle` object representing style properties that can be applied to a table. * * @remarks * [Api set: WordApi 1.6] @@ -116523,14 +116534,14 @@ declare namespace Word { */ baseStyle: string; /** - * Gets whether the specified style is a built-in style. + * Gets whether the style is a built-in style. * * @remarks * [Api set: WordApi 1.5] */ readonly builtIn: boolean; /** - * Gets the description of the specified style. + * Gets the description of the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -116545,7 +116556,7 @@ declare namespace Word { */ hasProofing: boolean; /** - * 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. + * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks * [Api set: WordApi 1.5] @@ -116566,7 +116577,7 @@ declare namespace Word { */ 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 whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks * [Api set: WordApi 1.5] @@ -116587,14 +116598,14 @@ declare namespace Word { */ locked: boolean; /** - * Gets the name of a style in the language of the user. + * Gets the name of the style in the language of the user. * * @remarks * [Api set: WordApi 1.5] */ readonly nameLocal: string; /** - * 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 name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks * [Api set: WordApi 1.5] @@ -116631,14 +116642,14 @@ declare namespace Word { */ readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * 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 whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks * [Api set: WordApi 1.5] */ unhideWhenUsed: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] @@ -116698,13 +116709,13 @@ declare namespace Word { */ untrack(): Word.Style; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Style` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Style` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.StyleData; } /** - * Represents the shading object. + * Represents the `Shading` object. * * @remarks * [Api set: WordApi 1.6] @@ -116771,9 +116782,9 @@ declare namespace Word { */ untrack(): Word.Shading; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Shading` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Shading` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShadingData; } /** @@ -116858,9 +116869,9 @@ declare namespace Word { */ untrack(): Word.ShadingUniversal; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShadingUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingUniversalData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShadingUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingUniversalData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShadingUniversalData; } /** @@ -116888,7 +116899,7 @@ declare namespace Word { */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the table. + * Gets the collection of `Field` objects in the table. * * @remarks * [Api set: WordApi 1.4] @@ -116980,7 +116991,7 @@ declare namespace Word { */ readonly tables: Word.TableCollection; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApi 1.3] @@ -117002,7 +117013,7 @@ declare namespace Word { */ headerRowCount: number; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] @@ -117101,7 +117112,7 @@ declare namespace Word { */ values: string[][]; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -117128,8 +117139,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table. - * @param columnCount Required. Number of columns to add. + * @param insertLocation It must be `start` or `end`, corresponding to the appropriate side of the table. + * @param columnCount Number of columns to add. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void; @@ -117139,8 +117150,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. It must be 'Start' or 'End'. - * @param rowCount Required. Number of rows to add. + * @param insertLocation It must be `start` or `end`. + * @param rowCount Number of rows to add. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; @@ -117205,7 +117216,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param options An object that specifies the options for converting the table to text. + * @param options Optional. An object that specifies the options for converting the table to text. * @returns A `Range` object that represents the converted text. */ convertToText(options?: Word.TableConvertToTextOptions): Word.Range; @@ -117222,7 +117233,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param columnIndex Required. The first column to delete. + * @param columnIndex The first column to delete. * @param columnCount Optional. The number of columns to delete. Default 1. */ deleteColumns(columnIndex: number, columnCount?: number): void; @@ -117232,7 +117243,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowIndex Required. The first row to delete. + * @param rowIndex The first row to delete. * @param rowCount Optional. The number of rows to delete. Default 1. */ deleteRows(rowIndex: number, rowCount?: number): void; @@ -117249,7 +117260,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** @@ -117258,7 +117269,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** @@ -117267,8 +117278,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowIndex Required. The index of the row. - * @param cellIndex Required. The index of the cell in the row. + * @param rowIndex The index of the row. + * @param cellIndex The index of the cell in the row. */ getCell(rowIndex: number, cellIndex: number): Word.TableCell; /** @@ -117277,8 +117288,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowIndex Required. The index of the row. - * @param cellIndex Required. The index of the cell in the row. + * @param rowIndex The index of the row. + * @param cellIndex The index of the cell in the row. */ getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell; /** @@ -117287,7 +117298,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** @@ -117296,7 +117307,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** @@ -117347,7 +117358,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, or `after`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range; /** @@ -117363,8 +117374,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** @@ -117373,9 +117384,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `before` or `after`. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; @@ -117385,10 +117396,10 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param topRow Required. The row of the first cell - * @param firstCell Required. The index of the first cell in its row - * @param bottomRow Required. The row of the last cell - * @param lastCell Required. The index of the last cell in its row + * @param topRow The row of the first cell. + * @param firstCell The index of the first cell in its row. + * @param bottomRow The row of the last cell. + * @param lastCell The index of the last cell in its row. */ mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; /** @@ -117400,12 +117411,12 @@ declare namespace Word { */ reapplyAutoFormat(): void; /** - * Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the `Table` object. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.3] * - * @param searchText Required. The search text. + * @param searchText The search text. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -117423,7 +117434,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -117432,7 +117443,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -117441,8 +117452,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** @@ -117451,8 +117462,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** @@ -117462,7 +117473,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param options An object that specifies the options for sorting the table. + * @param options Optional. An object that specifies the options for sorting the table. */ sort(options?: Word.TableSortOptions): void; /** @@ -117495,13 +117506,13 @@ declare namespace Word { */ untrack(): Word.Table; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableData; } /** - * Represents the TableStyle object. + * Represents the `TableStyle` object. * * @remarks * [Api set: WordApi 1.6] @@ -117533,7 +117544,7 @@ declare namespace Word { */ alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -117672,9 +117683,9 @@ declare namespace Word { */ untrack(): Word.TableStyle; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableStyleData; } /** @@ -117773,9 +117784,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -117836,7 +117847,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a `TabStop` object. + * @param index The location of a `TabStop` object. */ getItem(index: number): Word.TabStop; /** @@ -117866,9 +117877,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -117897,7 +117908,7 @@ declare namespace Word { leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; } /** - * Contains the collection of the document's Table objects. + * Contains the collection of the document's {@link Word.Table} objects. * * @remarks * [Api set: WordApi 1.3] @@ -117948,9 +117959,9 @@ declare namespace Word { */ untrack(): Word.TableCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableCollectionData; } /** @@ -118112,9 +118123,9 @@ declare namespace Word { */ untrack(): Word.TableColumn; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableColumnData; } /** @@ -118213,9 +118224,9 @@ declare namespace Word { */ untrack(): Word.TableColumnCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableColumnCollectionData; } /** @@ -118371,9 +118382,9 @@ declare namespace Word { */ untrack(): Word.TableOfAuthorities; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfAuthorities` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfAuthorities` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableOfAuthoritiesData; } /** @@ -118459,9 +118470,9 @@ declare namespace Word { */ untrack(): Word.TableOfAuthoritiesCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfAuthoritiesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.TableOfAuthoritiesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableOfAuthoritiesCollectionData; } /** @@ -118658,9 +118669,9 @@ declare namespace Word { */ untrack(): Word.TableOfAuthoritiesCategory; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfAuthoritiesCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryData`) that contains shallow copies of any loaded child properties from the original object. - */ + * 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.TableOfAuthoritiesCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryData; } /** @@ -118720,9 +118731,9 @@ declare namespace Word { */ untrack(): Word.TableOfAuthoritiesCategoryCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfAuthoritiesCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.TableOfAuthoritiesCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryCollectionData; } /** @@ -118891,9 +118902,9 @@ declare namespace Word { */ untrack(): Word.TableOfContents; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfContents` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfContents` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableOfContentsData; } /** @@ -118957,9 +118968,9 @@ declare namespace Word { */ untrack(): Word.TableOfContentsCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfContentsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfContentsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableOfContentsCollectionData; } /** @@ -119300,9 +119311,9 @@ declare namespace Word { */ untrack(): Word.TableOfFigures; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfFigures` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfFigures` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableOfFiguresData; } /** @@ -119366,9 +119377,9 @@ declare namespace Word { */ untrack(): Word.TableOfFiguresCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfFiguresCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfFiguresCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableOfFiguresCollectionData; } /** @@ -119515,7 +119526,7 @@ declare namespace Word { */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the table row. + * Gets the collection of `Field` objects in the table row. * * @remarks * [Api set: WordApi 1.4] @@ -119566,14 +119577,14 @@ declare namespace Word { */ readonly cellCount: number; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] */ horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks * [Api set: WordApi 1.3] @@ -119608,7 +119619,7 @@ declare namespace Word { */ values: string[][]; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -119652,7 +119663,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** @@ -119661,7 +119672,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** @@ -119670,7 +119681,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** @@ -119679,7 +119690,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** @@ -119709,8 +119720,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. - * @param rowCount Required. Number of rows to add + * @param insertLocation Where the new rows should be inserted, relative to the current row. It must be `before` or `after`. + * @param rowCount Number of rows to add. * @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. */ insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; @@ -119722,12 +119733,12 @@ declare namespace Word { */ merge(): Word.TableCell; /** - * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the row. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.3] * - * @param searchText Required. The search text. + * @param searchText The search text. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -119745,7 +119756,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -119754,7 +119765,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -119763,8 +119774,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** @@ -119773,8 +119784,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** @@ -119851,13 +119862,13 @@ declare namespace Word { */ untrack(): Word.TableRow; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableRowData; } /** - * Contains the collection of the document's TableRow objects. + * Contains the collection of the document's {@link Word.TableRow} objects. * * @remarks * [Api set: WordApi 1.3] @@ -119987,9 +119998,9 @@ declare namespace Word { */ untrack(): Word.TableRowCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableRowCollectionData; } /** @@ -120002,7 +120013,7 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the body object of the cell. + * Gets the `Body` object of the cell. * * @remarks * [Api set: WordApi 1.3] @@ -120053,7 +120064,7 @@ declare namespace Word { */ columnWidth: number; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -120081,7 +120092,7 @@ declare namespace Word { */ value: string; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -120150,7 +120161,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** @@ -120159,7 +120170,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** @@ -120168,7 +120179,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** @@ -120177,7 +120188,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** @@ -120200,8 +120211,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. It must be 'Before' or 'After'. - * @param columnCount Required. Number of columns to add. + * @param insertLocation It must be `before` or `after`. + * @param columnCount Number of columns to add. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; @@ -120211,8 +120222,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. It must be 'Before' or 'After'. - * @param rowCount Required. Number of rows to add. + * @param insertLocation It must be `before` or `after`. + * @param rowCount Number of rows to add. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; @@ -120240,8 +120251,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** @@ -120250,8 +120261,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** @@ -120260,8 +120271,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param rowCount Required. The number of rows to split into. Must be a divisor of the number of underlying rows. - * @param columnCount Required. The number of columns to split into. + * @param rowCount The number of rows to split into. Must be a divisor of the number of underlying rows. + * @param columnCount The number of columns to split into. */ split(rowCount: number, columnCount: number): void; /** @@ -120294,13 +120305,13 @@ declare namespace Word { */ untrack(): Word.TableCell; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableCellData; } /** - * Contains the collection of the document's TableCell objects. + * Contains the collection of the document's {@link Word.TableCell} objects. * * @remarks * [Api set: WordApi 1.3] @@ -120427,7 +120438,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param options TableCellCollectionSplitOptions. + * @param options Optional. Options for splitting the table cells. */ split(options?: Word.TableCellCollectionSplitOptions): void; /** @@ -120457,9 +120468,9 @@ declare namespace Word { */ untrack(): Word.TableCellCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableCellCollectionData; } /** @@ -120530,9 +120541,9 @@ declare namespace Word { */ untrack(): Word.TableBorder; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableBorderData; } /** @@ -120709,9 +120720,9 @@ declare namespace Word { */ untrack(): Word.Template; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TemplateData; } /** @@ -120740,7 +120751,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param index The index of the template to retrieve. + * @param index The index of the item to retrieve. */ getItemAt(index: number): Word.Template; /** @@ -120777,9 +120788,9 @@ declare namespace Word { */ untrack(): Word.TemplateCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TemplateCollectionData; } /** @@ -120845,6 +120856,8 @@ declare namespace Word { * * @remarks * [Api set: WordApi 1.6] + * + * @param rangeLocation Optional. Specifies the part of the tracked change to get the range for. If not specified, the whole range of the tracked change is returned. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** @@ -120884,9 +120897,9 @@ declare namespace Word { */ untrack(): Word.TrackedChange; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TrackedChangeData; } /** @@ -120955,9 +120968,9 @@ declare namespace Word { */ untrack(): Word.TrackedChangeCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TrackedChangeCollectionData; } /** @@ -121494,9 +121507,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -121509,14 +121522,14 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] */ readonly body: Word.Body; /** - * 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}. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -121544,14 +121557,14 @@ declare namespace Word { */ readonly parentGroup: Word.Shape; /** - * 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}. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApiDesktop 1.2] */ readonly shapeGroup: Word.ShapeGroup; /** - * Gets the text frame object of the shape. + * Gets the `TextFrame` object of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -121739,7 +121752,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param distance Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. + * @param distance Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. */ moveHorizontally(distance: number): void; /** @@ -121748,7 +121761,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. + * @param distance Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. */ moveVertically(distance: number): void; /** @@ -121801,7 +121814,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is false. + * @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is `false`. */ select(selectMultipleShapes?: boolean): void; /** @@ -121834,13 +121847,13 @@ declare namespace Word { */ untrack(): Word.Shape; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShapeData; } /** - * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. + * Represents a shape group in the document. To get the corresponding {@link Word.Shape} object, use `ShapeGroup.shape`. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -121849,14 +121862,14 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Shape object associated with the group. + * Gets the `Shape` object associated with the group. * * @remarks * [Api set: WordApiDesktop 1.2] */ readonly shape: Word.Shape; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Gets the collection of `Shape` objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -121914,13 +121927,13 @@ declare namespace Word { */ untrack(): Word.ShapeGroup; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShapeGroupData; } /** - * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * Represents a canvas in the document. To get the corresponding {@link Word.Shape} object, use `Canvas.shape`. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -121929,14 +121942,14 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Shape object associated with the canvas. + * Gets the `Shape` object associated with the canvas. * * @remarks * [Api set: WordApiDesktop 1.2] */ readonly shape: Word.Shape; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Gets the collection of {@link Word.Shape} objects. Currently, only text boxes, pictures, and geometric shapes are supported. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -121987,9 +122000,9 @@ declare namespace Word { */ untrack(): Word.Canvas; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CanvasData; } /** @@ -122009,7 +122022,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param types Required. An array of geometric shape subtypes. + * @param types An array of geometric shape subtypes. */ getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; /** @@ -122018,7 +122031,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param id Required. A shape identifier. + * @param id A shape identifier. */ getById(id: number): Word.Shape; /** @@ -122027,7 +122040,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param id Required. A shape identifier. + * @param id A shape identifier. */ getByIdOrNullObject(id: number): Word.Shape; /** @@ -122036,7 +122049,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param ids Required. An array of shape identifiers. + * @param ids An array of shape identifiers. */ getByIds(ids: number[]): Word.ShapeCollection; /** @@ -122045,7 +122058,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param names Required. An array of shape names. + * @param names An array of shape names. */ getByNames(names: string[]): Word.ShapeCollection; /** @@ -122054,7 +122067,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param types Required. An array of shape types. + * @param types An array of shape types. */ getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; /** @@ -122072,7 +122085,7 @@ declare namespace Word { */ getFirstOrNullObject(): Word.Shape; /** - * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes. + * Groups floating shapes in this collection, inline shapes will be skipped. Returns a `Shape` object that represents the new group of shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -122105,13 +122118,13 @@ declare namespace Word { */ untrack(): Word.ShapeCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ShapeCollectionData; } /** - * Represents the fill formatting of a shape object. + * Represents the fill formatting of a {@link Word.Shape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -122156,14 +122169,14 @@ declare namespace Word { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Word.ShapeFill): void; /** - * Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`; + * Clears the fill formatting of this shape and sets it to `Word.ShapeFillType.noFill`. * * @remarks * [Api set: WordApiDesktop 1.2] */ clear(): void; /** - * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`. + * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.solid`. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -122201,13 +122214,13 @@ declare namespace Word { */ untrack(): Word.ShapeFill; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShapeFillData; } /** - * Represents the text frame of a shape object. + * Represents the text frame of a {@link Word.Shape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -122216,63 +122229,63 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * 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 automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks * [Api set: WordApiDesktop 1.2] */ autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the bottom margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ bottomMargin: number; /** - * Specifies if the text frame contains text. + * Returns `true` if the text frame contains text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ readonly hasText: boolean; /** - * Represents the left margin, in points, of the text frame. + * Specifies the left margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ leftMargin: number; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. * * @remarks * [Api set: WordApiDesktop 1.2] */ noTextRotation: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks * [Api set: WordApiDesktop 1.2] */ orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Represents the right margin, in points, of the text frame. + * Specifies the right margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ rightMargin: number; /** - * Represents the top margin, in points, of the text frame. + * Specifies the top margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ topMargin: number; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -122323,13 +122336,13 @@ declare namespace Word { */ untrack(): Word.TextFrame; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TextFrameData; } /** - * Represents all the properties for wrapping text around a shape. + * Represents all the properties for wrapping text around a {@link Word.Shape}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -122417,9 +122430,9 @@ declare namespace Word { */ untrack(): Word.ShapeTextWrap; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShapeTextWrapData; } /** @@ -122478,9 +122491,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -122502,7 +122515,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index The index of the item to retrieve. + * @param index The location of the item to retrieve. */ getItem(index: number): Word.Reviewer; /** @@ -122532,9 +122545,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -122617,9 +122630,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -122697,9 +122710,9 @@ declare namespace Word { */ untrack(): Word.RepeatingSectionItem; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.RepeatingSectionItemData; } /** @@ -122745,9 +122758,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; }; @@ -122872,13 +122885,13 @@ declare namespace Word { */ untrack(): Word.Revision; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Revision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Revision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.RevisionData; } /** - * A collection of Revision objects that represent the changes marked with revision marks in a range or document. + * A collection of {@link Word.Revision} objects that represent the changes marked with revision marks in a range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -122904,7 +122917,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index The index of the item to retrieve. + * @param index The location of the item to retrieve. */ getItem(index: number): Word.Revision; /** @@ -122942,9 +122955,9 @@ declare namespace Word { */ untrack(): Word.RevisionCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RevisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RevisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.RevisionCollectionData; } /** @@ -123103,7 +123116,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param deleteContents Optional. If true, deletes the contents as well. + * @param deleteContents Optional. If `true`, deletes the contents as well. */ delete(deleteContents?: boolean): void; /** @@ -123145,9 +123158,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; } /** @@ -123320,9 +123333,9 @@ declare namespace Word { */ untrack(): Word.PictureContentControl; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.PictureContentControlData; } /** @@ -123502,9 +123515,9 @@ declare namespace Word { */ untrack(): Word.GroupContentControl; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.GroupContentControlData; } /** @@ -123687,7 +123700,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param options The options for configuring the content control's placeholder text. + * @param options Optional. The options for configuring the content control's placeholder text. */ setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** @@ -123720,9 +123733,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockGalleryContentControl; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; } /** @@ -123917,9 +123930,9 @@ declare namespace Word { */ untrack(): Word.RepeatingSectionContentControl; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.RepeatingSectionContentControlData; } /** @@ -123978,9 +123991,9 @@ declare namespace Word { */ untrack(): Word.ReadabilityStatistic; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ReadabilityStatistic` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReadabilityStatisticData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ReadabilityStatistic` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReadabilityStatisticData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ReadabilityStatisticData; } /** @@ -124002,7 +124015,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index The zero-based index of the readability statistic to get. + * @param index The zero-based index of the item to retrieve. */ getItemAt(index: number): Word.ReadabilityStatistic; /** @@ -124032,9 +124045,9 @@ declare namespace Word { */ untrack(): Word.ReadabilityStatisticCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ReadabilityStatisticCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReadabilityStatisticCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ReadabilityStatisticCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReadabilityStatisticCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ReadabilityStatisticCollectionData; } /** @@ -124165,9 +124178,9 @@ declare namespace Word { */ untrack(): Word.WebSettings; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.WebSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WebSettingsData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.WebSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WebSettingsData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.WebSettingsData; } /** @@ -124189,7 +124202,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a `XmlNode` object. + * @param index The location of a `XmlNode` object. */ getItem(index: number): Word.XmlNode; /** @@ -124199,7 +124212,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index The index of the XML node to retrieve. + * @param index The index of the item to retrieve. */ getItemAt(index: number): Word.XmlNode; /** @@ -124229,9 +124242,9 @@ declare namespace Word { */ untrack(): Word.XmlNodeCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.XmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.XmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.XmlNodeCollectionData; } /** @@ -124539,9 +124552,9 @@ declare namespace Word { */ untrack(): Word.XmlNode; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.XmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlNodeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.XmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlNodeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.XmlNodeData; } /** @@ -124927,9 +124940,9 @@ declare namespace Word { */ untrack(): Word.HtmlDivision; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.HtmlDivision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HtmlDivisionData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HtmlDivision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HtmlDivisionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.HtmlDivisionData; } /** @@ -124951,7 +124964,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index The index of the `HtmlDivision` to retrieve. + * @param index The index of the item to retrieve. */ getItemAt(index: number): Word.HtmlDivision; /** @@ -124973,9 +124986,9 @@ declare namespace Word { */ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HtmlDivisionCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.HtmlDivisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HtmlDivisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HtmlDivisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HtmlDivisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.HtmlDivisionCollectionData; } /** @@ -125258,9 +125271,9 @@ declare namespace Word { */ untrack(): Word.Frame; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.FrameData; } /** @@ -125327,9 +125340,9 @@ declare namespace Word { */ untrack(): Word.FrameCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.FrameCollectionData; } /** @@ -125392,9 +125405,9 @@ declare namespace Word { */ untrack(): Word.DocumentLibraryVersion; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.DocumentLibraryVersionData; } /** @@ -125451,9 +125464,9 @@ declare namespace Word { */ untrack(): Word.DocumentLibraryVersionCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; } /** @@ -125561,18 +125574,20 @@ declare namespace Word { formatted = "Formatted", } /** - * Note item type + * Note item type. * * @remarks * [Api set: WordApi 1.5] */ enum NoteItemType { /** + * Footnote type. * @remarks * [Api set: WordApi 1.5] */ footnote = "Footnote", /** + * Endnote type. * @remarks * [Api set: WordApi 1.5] */ @@ -125713,25 +125728,27 @@ declare namespace Word { */ enum EventSource { /** + * Local source. * @remarks * [Api set: WordApi 1.5] */ local = "Local", /** + * Remote source. * @remarks * [Api set: WordApi 1.5] */ remote = "Remote", } /** - * Provides information about the content control that raised contentControlAdded event. + * Provides information about the content control that raised the `contentControlAdded` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlAddedEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -125753,14 +125770,14 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the content control that raised contentControlDataChanged event. + * Provides information about the content control that raised the `contentControlDataChanged` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlDataChangedEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -125782,14 +125799,14 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the content control that raised contentControlDeleted event. + * Provides information about the content control that raised the `contentControlDeleted` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlDeletedEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -125811,14 +125828,14 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the content control that raised contentControlEntered event. + * Provides information about the content control that raised the `contentControlEntered` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlEnteredEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -125840,14 +125857,14 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the content control that raised contentControlExited event. + * Provides information about the content control that raised the `contentControlExited` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlExitedEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -125956,20 +125973,20 @@ declare namespace Word { */ 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. - */ + * 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 content control that raised contentControlSelectionChanged event. + * Provides information about the content control that raised the `contentControlSelectionChanged` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlSelectionChangedEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -125991,7 +126008,7 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the paragraphs that raised the paragraphAdded event. + * Provides information about the paragraphs that raised the `paragraphAdded` event. * * @remarks * [Api set: WordApi 1.6] @@ -126005,7 +126022,7 @@ declare namespace Word { */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -126020,7 +126037,7 @@ declare namespace Word { uniqueLocalIds: string[]; } /** - * Provides information about the paragraphs that raised the paragraphChanged event. + * Provides information about the paragraphs that raised the `paragraphChanged` event. * * @remarks * [Api set: WordApi 1.6] @@ -126034,7 +126051,7 @@ declare namespace Word { */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -126049,7 +126066,7 @@ declare namespace Word { uniqueLocalIds: string[]; } /** - * Provides information about the paragraphs that raised the paragraphDeleted event. + * Provides information about the paragraphs that raised the `paragraphDeleted` event. * * @remarks * [Api set: WordApi 1.6] @@ -126063,7 +126080,7 @@ declare namespace Word { */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -126086,7 +126103,7 @@ declare namespace Word { */ interface CommentEventArgs { /** - * Represents how the comment changed event is triggered. + * Represents how the `commentChanged` event is raised. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -126094,7 +126111,7 @@ declare namespace Word { */ changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; /** - * Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. + * Gets the `CommentDetail` array which contains the IDs and reply IDs of the involved comments. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -126110,7 +126127,7 @@ declare namespace Word { */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -126209,107 +126226,119 @@ declare namespace Word { */ enum ContentControlType { /** + * Unknown content control type. * @remarks * [Api set: WordApi 1.1] */ unknown = "Unknown", /** + * Rich text content control subtype containing inline elements. * @remarks * [Api set: WordApi 1.1] */ richTextInline = "RichTextInline", /** + * Rich text content control subtype containing paragraphs. * @remarks * [Api set: WordApi 1.1] */ richTextParagraphs = "RichTextParagraphs", /** - * Contains a whole cell. + * Rich text content control subtype containing a whole cell. * @remarks * [Api set: WordApi 1.1] */ richTextTableCell = "RichTextTableCell", /** - * Contains a whole row. + * Rich text content control subtype containing a whole row. * @remarks * [Api set: WordApi 1.1] */ richTextTableRow = "RichTextTableRow", /** - * Contains a whole table. + * Rich text content control subtype containing a whole table. * @remarks * [Api set: WordApi 1.1] */ richTextTable = "RichTextTable", /** + * Plain text content control subtype containing inline elements. * @remarks * [Api set: WordApi 1.1] */ plainTextInline = "PlainTextInline", /** + * Plain text content control subtype containing paragraphs. * @remarks * [Api set: WordApi 1.1] */ plainTextParagraph = "PlainTextParagraph", /** + * Picture content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ picture = "Picture", /** + * Building block gallery content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ buildingBlockGallery = "BuildingBlockGallery", /** + * Check box content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ checkBox = "CheckBox", /** + * Combo box content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ comboBox = "ComboBox", /** + * Dropdown list content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ dropDownList = "DropDownList", /** + * Date picker content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ datePicker = "DatePicker", /** + * Repeating section content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ repeatingSection = "RepeatingSection", /** - * Identifies a rich text content control. + * Rich text content control type. * @remarks * [Api set: WordApi 1.1] */ richText = "RichText", /** + * Plain text content control type. * @remarks * [Api set: WordApi 1.1] */ plainText = "PlainText", /** + * Group content control type. * @remarks * [Api set: WordApi 1.1] */ group = "Group", } /** - * ContentControl appearance. + * Represents the content control appearance. * * @remarks * [Api set: WordApi 1.1] - * - * Content control appearance options are BoundingBox, Tags, or Hidden. */ enum ContentControlAppearance { /** @@ -126332,7 +126361,7 @@ declare namespace Word { hidden = "Hidden", } /** - * Content control level types. + * Represents the content control level type. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -126387,7 +126416,7 @@ declare namespace Word { warning = "Warning", } /** - * The supported styles for underline format. + * Represents the supported styles for underline format. * * @remarks * [Api set: WordApi 1.1] @@ -126449,6 +126478,7 @@ declare namespace Word { */ dotted = "Dotted", /** + * A heavy dotted underline. * @remarks * [Api set: WordApi 1.1] */ @@ -126460,16 +126490,19 @@ declare namespace Word { */ dashLine = "DashLine", /** + * A heavy dash underline. * @remarks * [Api set: WordApi 1.1] */ dashLineHeavy = "DashLineHeavy", /** + * A long dash underline. * @remarks * [Api set: WordApi 1.1] */ dashLineLong = "DashLineLong", /** + * A long heavy dash underline. * @remarks * [Api set: WordApi 1.1] */ @@ -126481,6 +126514,7 @@ declare namespace Word { */ dotDashLine = "DotDashLine", /** + * A heavy dot-dash underline. * @remarks * [Api set: WordApi 1.1] */ @@ -126492,6 +126526,7 @@ declare namespace Word { */ twoDotDashLine = "TwoDotDashLine", /** + * An alternating heavy dot-dot-dash underline. * @remarks * [Api set: WordApi 1.1] */ @@ -126503,11 +126538,13 @@ declare namespace Word { */ wave = "Wave", /** + * A heavy wavy underline. * @remarks * [Api set: WordApi 1.1] */ waveHeavy = "WaveHeavy", /** + * A double wavy underline. * @remarks * [Api set: WordApi 1.1] */ @@ -126565,14 +126602,14 @@ declare namespace Word { line = "Line", } /** - * The insertion location types. + * Represents the insertion location type. * * @remarks * [Api set: WordApi 1.1] * * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. - * If the location is "Before" or "After", the new content will be outside of the modified object. - * If the location is "Start" or "End", the new content will be included as part of the modified object. + * If the location is `before` or `after`, the new content will be outside of the modified object. + * If the location is `start` or `end`, the new content will be included as part of the modified object. */ enum InsertLocation { /** @@ -126607,11 +126644,14 @@ declare namespace Word { replace = "Replace", } /** + * Represents the horizontal alignment of text. + * * @remarks * [Api set: WordApi 1.1] */ enum Alignment { /** + * Mixed horizontal alignment. * @remarks * [Api set: WordApi 1.1] */ @@ -126648,6 +126688,8 @@ declare namespace Word { justified = "Justified", } /** + * Represents the type of header or footer. + * * @remarks * [Api set: WordApi 1.1] */ @@ -126672,7 +126714,7 @@ declare namespace Word { evenPages = "EvenPages", } /** - * Represents the types of body objects. + * Represents the types of `Body` objects. * * @remarks * [Api set: WordApi 1.3] @@ -126741,7 +126783,7 @@ declare namespace Word { shape = "Shape", } /** - * This enum sets where the cursor (insertion point) in the document is after a selection. + * Represents where the cursor (insertion point) is set in the document after a selection. * * @remarks * [Api set: WordApi 1.1] @@ -126767,76 +126809,92 @@ declare namespace Word { end = "End", } /** + * Represents image format type. + * * @remarks * [Api set: WordApiDesktop 1.1] */ enum ImageFormat { /** + * Unsupported image format. * @remarks * [Api set: WordApiDesktop 1.1] */ unsupported = "Unsupported", /** + * Undefined image format. * @remarks * [Api set: WordApiDesktop 1.1] */ undefined = "Undefined", /** + * Bitmap image format. * @remarks * [Api set: WordApiDesktop 1.1] */ bmp = "Bmp", /** + * JPEG image format. * @remarks * [Api set: WordApiDesktop 1.1] */ jpeg = "Jpeg", /** + * GIF image format. * @remarks * [Api set: WordApiDesktop 1.1] */ gif = "Gif", /** + * TIFF image format. * @remarks * [Api set: WordApiDesktop 1.1] */ tiff = "Tiff", /** + * PNG image format. * @remarks * [Api set: WordApiDesktop 1.1] */ png = "Png", /** + * Icon image format. * @remarks * [Api set: WordApiDesktop 1.1] */ icon = "Icon", /** + * Exif image format. * @remarks * [Api set: WordApiDesktop 1.1] */ exif = "Exif", /** + * Windows Metafile image format. * @remarks * [Api set: WordApiDesktop 1.1] */ wmf = "Wmf", /** + * Enhanced Metafile image format. * @remarks * [Api set: WordApiDesktop 1.1] */ emf = "Emf", /** + * PICT image format. * @remarks * [Api set: WordApiDesktop 1.1] */ pict = "Pict", /** + * PDF image format. * @remarks * [Api set: WordApiDesktop 1.1] */ pdf = "Pdf", /** + * SVG image format. * @remarks * [Api set: WordApiDesktop 1.1] */ @@ -126880,19 +126938,21 @@ declare namespace Word { */ after = "After", /** - * The range between 'Start' and 'End'. + * The range between `start` and `end`. * @remarks * [Api set: WordApi 1.3] */ content = "Content", } /** + * Represents the relationship of the location of this instance to another range. + * * @remarks * [Api set: WordApi 1.3] */ enum LocationRelation { /** - * Indicates that this instance and the range are in different sub-documents. + * Indicates that this instance and the range are in different subdocuments. * @remarks * [Api set: WordApi 1.3] */ @@ -126977,77 +127037,94 @@ declare namespace Word { after = "After", } /** + * Represents the location of a {@link Word.Border | border}. + * * @remarks * [Api set: WordApi 1.3] */ enum BorderLocation { /** + * Top border. * @remarks * [Api set: WordApi 1.3] */ top = "Top", /** + * Left border. * @remarks * [Api set: WordApi 1.3] */ left = "Left", /** + * Bottom border. * @remarks * [Api set: WordApi 1.3] */ bottom = "Bottom", /** + * Right border. * @remarks * [Api set: WordApi 1.3] */ right = "Right", /** + * Inside horizontal border. * @remarks * [Api set: WordApi 1.3] */ insideHorizontal = "InsideHorizontal", /** + * Inside vertical border. * @remarks * [Api set: WordApi 1.3] */ insideVertical = "InsideVertical", /** + * Inside border. * @remarks * [Api set: WordApi 1.3] */ inside = "Inside", /** + * Outside border. * @remarks * [Api set: WordApi 1.3] */ outside = "Outside", /** + * All borders. * @remarks * [Api set: WordApi 1.3] */ all = "All", } /** + * Represents the location of cell padding. + * * @remarks * [Api set: WordApi 1.3] */ enum CellPaddingLocation { /** + * Padding at the top of the cell. * @remarks * [Api set: WordApi 1.3] */ top = "Top", /** + * Padding at the left of the cell. * @remarks * [Api set: WordApi 1.3] */ left = "Left", /** + * Padding at the bottom of the cell. * @remarks * [Api set: WordApi 1.3] */ bottom = "Bottom", /** + * Padding at the right of the cell. * @remarks * [Api set: WordApi 1.3] */ @@ -127128,152 +127205,184 @@ declare namespace Word { mixed = "Mixed", } /** + * The {@link Word.Border | border} types. + * * @remarks * [Api set: WordApi 1.3] */ enum BorderType { /** + * Mixed border type. * @remarks * [Api set: WordApi 1.3] */ mixed = "Mixed", /** + * No border. * @remarks * [Api set: WordApi 1.3] */ none = "None", /** + * Single border. * @remarks * [Api set: WordApi 1.3] */ single = "Single", /** + * Double border. * @remarks * [Api set: WordApi 1.3] */ double = "Double", /** + * Dotted border. * @remarks * [Api set: WordApi 1.3] */ dotted = "Dotted", /** + * Dashed border. * @remarks * [Api set: WordApi 1.3] */ dashed = "Dashed", /** + * Dot-dashed border. * @remarks * [Api set: WordApi 1.3] */ dotDashed = "DotDashed", /** + * Double dot-dashed border. * @remarks * [Api set: WordApi 1.3] */ dot2Dashed = "Dot2Dashed", /** + * Triple border. * @remarks * [Api set: WordApi 1.3] */ triple = "Triple", /** + * Thin-thick small border. * @remarks * [Api set: WordApi 1.3] */ thinThickSmall = "ThinThickSmall", /** + * Thick-thin small border. * @remarks * [Api set: WordApi 1.3] */ thickThinSmall = "ThickThinSmall", /** + * Thin-thick-thin small border. * @remarks * [Api set: WordApi 1.3] */ thinThickThinSmall = "ThinThickThinSmall", /** + * Thin-thick medium border. * @remarks * [Api set: WordApi 1.3] */ thinThickMed = "ThinThickMed", /** + * Thick-thin medium border. * @remarks * [Api set: WordApi 1.3] */ thickThinMed = "ThickThinMed", /** + * Thin-thick-thin medium border. * @remarks * [Api set: WordApi 1.3] */ thinThickThinMed = "ThinThickThinMed", /** + * Thin-thick large border. * @remarks * [Api set: WordApi 1.3] */ thinThickLarge = "ThinThickLarge", /** + * Thick-thin large border. * @remarks * [Api set: WordApi 1.3] */ thickThinLarge = "ThickThinLarge", /** + * Thin-thick-thin large border. * @remarks * [Api set: WordApi 1.3] */ thinThickThinLarge = "ThinThickThinLarge", /** + * Wave border. * @remarks * [Api set: WordApi 1.3] */ wave = "Wave", /** + * Double wave border. * @remarks * [Api set: WordApi 1.3] */ doubleWave = "DoubleWave", /** + * Dashed small border. * @remarks * [Api set: WordApi 1.3] */ dashedSmall = "DashedSmall", /** + * Dash-dot-stroked border. * @remarks * [Api set: WordApi 1.3] */ dashDotStroked = "DashDotStroked", /** + * 3D Emboss border. * @remarks * [Api set: WordApi 1.3] */ threeDEmboss = "ThreeDEmboss", /** + * 3D Engrave border. * @remarks * [Api set: WordApi 1.3] */ threeDEngrave = "ThreeDEngrave", } /** + * Represents the vertical alignment of text. + * * @remarks * [Api set: WordApi 1.3] */ enum VerticalAlignment { /** + * Mixed vertical alignment. * @remarks * [Api set: WordApi 1.3] */ mixed = "Mixed", /** + * Top vertical alignment. * @remarks * [Api set: WordApi 1.3] */ top = "Top", /** + * Center vertical alignment. * @remarks * [Api set: WordApi 1.3] */ center = "Center", /** + * Bottom vertical alignment. * @remarks * [Api set: WordApi 1.3] */ @@ -127324,98 +127433,120 @@ declare namespace Word { auto = "Auto", } /** + * Represents the type of list level. + * * @remarks * [Api set: WordApi 1.3] */ enum ListLevelType { /** + * Represents the bullet type. * @remarks * [Api set: WordApi 1.3] */ bullet = "Bullet", /** + * Represents the numbering type. * @remarks * [Api set: WordApi 1.3] */ number = "Number", /** + * Represents the picture type. * @remarks * [Api set: WordApi 1.3] */ picture = "Picture", } /** + * Represents the bullet style in a list. + * * @remarks * [Api set: WordApi 1.3] */ enum ListBullet { /** + * Represents custom bullet. * @remarks * [Api set: WordApi 1.3] */ custom = "Custom", /** + * Represents solid bullet. * @remarks * [Api set: WordApi 1.3] */ solid = "Solid", /** + * Represents hollow bullet. * @remarks * [Api set: WordApi 1.3] */ hollow = "Hollow", /** + * Represents square bullet. * @remarks * [Api set: WordApi 1.3] */ square = "Square", /** + * Represents diamond bullet. * @remarks * [Api set: WordApi 1.3] */ diamonds = "Diamonds", /** + * Represents arrow bullet. * @remarks * [Api set: WordApi 1.3] */ arrow = "Arrow", /** + * Represents checkmark bullet. * @remarks * [Api set: WordApi 1.3] */ checkmark = "Checkmark", } /** + * Represents the numbering style in a list. + * * @remarks * [Api set: WordApi 1.3] */ enum ListNumbering { /** + * Represents no numbering. * @remarks * [Api set: WordApi 1.3] */ none = "None", /** + * Represents Arabic numbering. * @remarks * [Api set: WordApi 1.3] */ arabic = "Arabic", /** + * Represents upper Roman numeral numbering. * @remarks * [Api set: WordApi 1.3] */ upperRoman = "UpperRoman", /** + * Represents lower Roman numeral numbering. * @remarks * [Api set: WordApi 1.3] */ lowerRoman = "LowerRoman", /** + * Represents upper letter numbering. * @remarks * [Api set: WordApi 1.3] */ upperLetter = "UpperLetter", /** + * Represents lower letter numbering. * @remarks * [Api set: WordApi 1.3] */ @@ -127443,46 +127574,55 @@ declare namespace Word { */ normal = "Normal", /** + * Heading 1 style. * @remarks * [Api set: WordApi 1.3] */ heading1 = "Heading1", /** + * Heading 2 style. * @remarks * [Api set: WordApi 1.3] */ heading2 = "Heading2", /** + * Heading 3 style. * @remarks * [Api set: WordApi 1.3] */ heading3 = "Heading3", /** + * Heading 4 style. * @remarks * [Api set: WordApi 1.3] */ heading4 = "Heading4", /** + * Heading 5 style. * @remarks * [Api set: WordApi 1.3] */ heading5 = "Heading5", /** + * Heading 6 style. * @remarks * [Api set: WordApi 1.3] */ heading6 = "Heading6", /** + * Heading 7 style. * @remarks * [Api set: WordApi 1.3] */ heading7 = "Heading7", /** + * Heading 8 style. * @remarks * [Api set: WordApi 1.3] */ heading8 = "Heading8", /** + * Heading 9 style. * @remarks * [Api set: WordApi 1.3] */ @@ -127542,111 +127682,133 @@ declare namespace Word { */ toc9 = "Toc9", /** + * Footnote text style. * @remarks * [Api set: WordApi 1.3] */ footnoteText = "FootnoteText", /** + * Header style. * @remarks * [Api set: WordApi 1.3] */ header = "Header", /** + * Footer style. * @remarks * [Api set: WordApi 1.3] */ footer = "Footer", /** + * Caption style. * @remarks * [Api set: WordApi 1.3] */ caption = "Caption", /** + * Footnote reference style. * @remarks * [Api set: WordApi 1.3] */ footnoteReference = "FootnoteReference", /** + * Endnote reference style. * @remarks * [Api set: WordApi 1.3] */ endnoteReference = "EndnoteReference", /** + * Endnote text style. * @remarks * [Api set: WordApi 1.3] */ endnoteText = "EndnoteText", /** + * Title style. * @remarks * [Api set: WordApi 1.3] */ title = "Title", /** + * Subtitle style. * @remarks * [Api set: WordApi 1.3] */ subtitle = "Subtitle", /** + * Hyperlink style. * @remarks * [Api set: WordApi 1.3] */ hyperlink = "Hyperlink", /** + * Strong style. * @remarks * [Api set: WordApi 1.3] */ strong = "Strong", /** + * Emphasis style. * @remarks * [Api set: WordApi 1.3] */ emphasis = "Emphasis", /** + * No spacing style. * @remarks * [Api set: WordApi 1.3] */ noSpacing = "NoSpacing", /** + * List paragraph style. * @remarks * [Api set: WordApi 1.3] */ listParagraph = "ListParagraph", /** + * Quote style. * @remarks * [Api set: WordApi 1.3] */ quote = "Quote", /** + * Intense quote style. * @remarks * [Api set: WordApi 1.3] */ intenseQuote = "IntenseQuote", /** + * Subtle emphasis style. * @remarks * [Api set: WordApi 1.3] */ subtleEmphasis = "SubtleEmphasis", /** + * Intense emphasis style. * @remarks * [Api set: WordApi 1.3] */ intenseEmphasis = "IntenseEmphasis", /** + * Subtle reference style. * @remarks * [Api set: WordApi 1.3] */ subtleReference = "SubtleReference", /** + * Intense reference style. * @remarks * [Api set: WordApi 1.3] */ intenseReference = "IntenseReference", /** + * Book title style. * @remarks * [Api set: WordApi 1.3] */ bookTitle = "BookTitle", /** + * Bibliography style. * @remarks * [Api set: WordApi 1.3] */ @@ -127658,552 +127820,663 @@ declare namespace Word { */ tocHeading = "TocHeading", /** + * Table grid style. * @remarks * [Api set: WordApi 1.3] */ tableGrid = "TableGrid", /** + * Plain table style 1. * @remarks * [Api set: WordApi 1.3] */ plainTable1 = "PlainTable1", /** + * Plain table style 2. * @remarks * [Api set: WordApi 1.3] */ plainTable2 = "PlainTable2", /** + * Plain table style 3. * @remarks * [Api set: WordApi 1.3] */ plainTable3 = "PlainTable3", /** + * Plain table style 4. * @remarks * [Api set: WordApi 1.3] */ plainTable4 = "PlainTable4", /** + * Plain table style 5. * @remarks * [Api set: WordApi 1.3] */ plainTable5 = "PlainTable5", /** + * Table grid light style. * @remarks * [Api set: WordApi 1.3] */ tableGridLight = "TableGridLight", /** + * Grid table light style 1. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light = "GridTable1Light", /** + * Grid table light style 1, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent1 = "GridTable1Light_Accent1", /** + * Grid table light style 1, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent2 = "GridTable1Light_Accent2", /** + * Grid table light style 1, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent3 = "GridTable1Light_Accent3", /** + * Grid table light style 1, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent4 = "GridTable1Light_Accent4", /** + * Grid table light style 1, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent5 = "GridTable1Light_Accent5", /** + * Grid table light style 1, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent6 = "GridTable1Light_Accent6", /** + * Grid table style 2. * @remarks * [Api set: WordApi 1.3] */ gridTable2 = "GridTable2", /** + * Grid table style 2, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent1 = "GridTable2_Accent1", /** + * Grid table style 2, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent2 = "GridTable2_Accent2", /** + * Grid table style 2, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent3 = "GridTable2_Accent3", /** + * Grid table style 2, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent4 = "GridTable2_Accent4", /** + * Grid table style 2, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent5 = "GridTable2_Accent5", /** + * Grid table style 2, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent6 = "GridTable2_Accent6", /** + * Grid table style 3. * @remarks * [Api set: WordApi 1.3] */ gridTable3 = "GridTable3", /** + * Grid table style 3, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent1 = "GridTable3_Accent1", /** + * Grid table style 3, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent2 = "GridTable3_Accent2", /** + * Grid table style 3, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent3 = "GridTable3_Accent3", /** + * Grid table style 3, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent4 = "GridTable3_Accent4", /** + * Grid table style 3, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent5 = "GridTable3_Accent5", /** + * Grid table style 3, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent6 = "GridTable3_Accent6", /** + * Grid table style 4. * @remarks * [Api set: WordApi 1.3] */ gridTable4 = "GridTable4", /** + * Grid table style 4, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent1 = "GridTable4_Accent1", /** + * Grid table style 4, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent2 = "GridTable4_Accent2", /** + * Grid table style 4, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent3 = "GridTable4_Accent3", /** + * Grid table style 4, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent4 = "GridTable4_Accent4", /** + * Grid table style 4, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent5 = "GridTable4_Accent5", /** + * Grid table style 4, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent6 = "GridTable4_Accent6", /** + * Grid table dark style 5. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark = "GridTable5Dark", /** + * Grid table dark style 5, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", /** + * Grid table dark style 5, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", /** + * Grid table dark style 5, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", /** + * Grid table dark style 5, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", /** + * Grid table dark style 5, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", /** + * Grid table dark style 5, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", /** + * Grid table colorful style 6. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful = "GridTable6Colorful", /** + * Grid table colorful style 6, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", /** + * Grid table colorful style 6, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", /** + * Grid table colorful style 6, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", /** + * Grid table colorful style 6, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", /** + * Grid table colorful style 6, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", /** + * Grid table colorful style 6, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", /** + * Grid table colorful style 7. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful = "GridTable7Colorful", /** + * Grid table colorful style 7, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", /** + * Grid table colorful style 7, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", /** + * Grid table colorful style 7, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", /** + * Grid table colorful style 7, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", /** + * Grid table colorful style 7, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", /** + * Grid table colorful style 7, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", /** + * List table light style 1. * @remarks * [Api set: WordApi 1.3] */ listTable1Light = "ListTable1Light", /** + * List table light style 1, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent1 = "ListTable1Light_Accent1", /** + * List table light style 1, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent2 = "ListTable1Light_Accent2", /** + * List table light style 1, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent3 = "ListTable1Light_Accent3", /** + * List table light style 1, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent4 = "ListTable1Light_Accent4", /** + * List table light style 1, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent5 = "ListTable1Light_Accent5", /** + * List table light style 1, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent6 = "ListTable1Light_Accent6", /** + * List table style 2. * @remarks * [Api set: WordApi 1.3] */ listTable2 = "ListTable2", /** + * List table style 2, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent1 = "ListTable2_Accent1", /** + * List table style 2, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent2 = "ListTable2_Accent2", /** + * List table style 2, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent3 = "ListTable2_Accent3", /** + * List table style 2, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent4 = "ListTable2_Accent4", /** + * List table style 2, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent5 = "ListTable2_Accent5", /** + * List table style 2, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent6 = "ListTable2_Accent6", /** + * List table style 3. * @remarks * [Api set: WordApi 1.3] */ listTable3 = "ListTable3", /** + * List table style 3, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent1 = "ListTable3_Accent1", /** + * List table style 3, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent2 = "ListTable3_Accent2", /** + * List table style 3, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent3 = "ListTable3_Accent3", /** + * List table style 3, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent4 = "ListTable3_Accent4", /** + * List table style 3, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent5 = "ListTable3_Accent5", /** + * List table style 3, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent6 = "ListTable3_Accent6", /** + * List table style 4. * @remarks * [Api set: WordApi 1.3] */ listTable4 = "ListTable4", /** + * List table style 4, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent1 = "ListTable4_Accent1", /** + * List table style 4, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent2 = "ListTable4_Accent2", /** + * List table style 4, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent3 = "ListTable4_Accent3", /** + * List table style 4, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent4 = "ListTable4_Accent4", /** + * List table style 4, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent5 = "ListTable4_Accent5", /** + * List table style 4, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent6 = "ListTable4_Accent6", /** + * List table dark style 5. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark = "ListTable5Dark", /** + * List table dark style 5, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent1 = "ListTable5Dark_Accent1", /** + * List table dark style 5, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent2 = "ListTable5Dark_Accent2", /** + * List table dark style 5, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent3 = "ListTable5Dark_Accent3", /** + * List table dark style 5, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent4 = "ListTable5Dark_Accent4", /** + * List table dark style 5, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent5 = "ListTable5Dark_Accent5", /** + * List table dark style 5, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent6 = "ListTable5Dark_Accent6", /** + * List table colorful style 6. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful = "ListTable6Colorful", /** + * List table colorful style 6, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", /** + * List table colorful style 6, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", /** + * List table colorful style 6, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", /** + * List table colorful style 6, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", /** + * List table colorful style 6, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", /** + * List table colorful style 6, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", /** + * List table colorful style 7. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful = "ListTable7Colorful", /** + * List table colorful style 7, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", /** + * List table colorful style 7, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", /** + * List table colorful style 7, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", /** + * List table colorful style 7, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", /** + * List table colorful style 7, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", /** + * List table colorful style 7, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", } /** + * Represents the document property type. + * * @remarks * [Api set: WordApi 1.3] */ enum DocumentPropertyType { /** + * Represents a string type. * @remarks * [Api set: WordApi 1.3] */ string = "String", /** + * Represents a number type. * @remarks * [Api set: WordApi 1.3] */ number = "Number", /** + * Represents a date type. * @remarks * [Api set: WordApi 1.3] */ date = "Date", /** + * Represents a Boolean type. * @remarks * [Api set: WordApi 1.3] */ @@ -129067,7 +129340,7 @@ declare namespace Word { */ from?: number; /** - * If provided, specifies the item to print. The default value is `PrintOutItem.documentContent`. + * If provided, specifies the item to print. The default value is `documentContent`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -129091,7 +129364,7 @@ declare namespace Word { */ outputFileName?: string; /** - * If provided, specifies the page order. The default value is `PrintOutPages.allPages`. + * If provided, specifies the page order. The default value is `allPages`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -131415,7 +131688,7 @@ declare namespace Word { prompt = "Prompt", } /** - * Represents the type of Field. + * Represents the type of {@link Word.Field} object. * * @remarks * [Api set: WordApi 1.5] @@ -131963,7 +132236,7 @@ declare namespace Word { undefined = "Undefined", } /** - * Represents the kind of field. Indicates how the field works in relation to updating. + * Represents the kind of {@link Word.Field} object. Indicates how the field works in relation to updating. * * @remarks * [Api set: WordApi 1.5] @@ -131995,7 +132268,7 @@ declare namespace Word { cold = "Cold", } /** - * Represents the character inserted after the list item mark. + * Represents the character inserted after the {@link Word.ListItem | list item} mark. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -132021,346 +132294,416 @@ declare namespace Word { trailingNone = "TrailingNone", } /** + * Represents the built-in number styles for lists in Word. + * * @remarks * [Api set: WordApiDesktop 1.1] */ enum ListBuiltInNumberStyle { /** + * No built-in number style. * @remarks * [Api set: WordApiDesktop 1.1] */ none = "None", /** + * Arabic numerals (1, 2, 3, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ arabic = "Arabic", /** + * Uppercase Roman numerals (I, II, III, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ upperRoman = "UpperRoman", /** + * Lowercase Roman numerals (i, ii, iii, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ lowerRoman = "LowerRoman", /** + * Uppercase letters (A, B, C, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ upperLetter = "UpperLetter", /** + * Lowercase letters (a, b, c, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ lowerLetter = "LowerLetter", /** + * Ordinal numbers (1st, 2nd, 3rd, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ ordinal = "Ordinal", /** + * Cardinal numbers as text (one, two, three, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ cardinalText = "CardinalText", /** + * Ordinal numbers as text (first, second, third, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ ordinalText = "OrdinalText", /** + * Kanji. * @remarks * [Api set: WordApiDesktop 1.1] */ kanji = "Kanji", /** + * Kanji digits. * @remarks * [Api set: WordApiDesktop 1.1] */ kanjiDigit = "KanjiDigit", /** + * Aiueo half width characters. * @remarks * [Api set: WordApiDesktop 1.1] */ aiueoHalfWidth = "AiueoHalfWidth", /** + * Iroha half width characters. * @remarks * [Api set: WordApiDesktop 1.1] */ irohaHalfWidth = "IrohaHalfWidth", /** + * Arabic full-width numbers. * @remarks * [Api set: WordApiDesktop 1.1] */ arabicFullWidth = "ArabicFullWidth", /** + * Traditional Kanji characters. * @remarks * [Api set: WordApiDesktop 1.1] */ kanjiTraditional = "KanjiTraditional", /** + * Traditional Kanji characters (alternative form). * @remarks * [Api set: WordApiDesktop 1.1] */ kanjiTraditional2 = "KanjiTraditional2", /** + * Numbers enclosed in a circle. * @remarks * [Api set: WordApiDesktop 1.1] */ numberInCircle = "NumberInCircle", /** + * Aiueo characters. * @remarks * [Api set: WordApiDesktop 1.1] */ aiueo = "Aiueo", /** + * Iroha characters. * @remarks * [Api set: WordApiDesktop 1.1] */ iroha = "Iroha", /** + * Arabic full-width numbers with leading zeros. * @remarks * [Api set: WordApiDesktop 1.1] */ arabicLZ = "ArabicLZ", /** + * Bullet characters. * @remarks * [Api set: WordApiDesktop 1.1] */ bullet = "Bullet", /** + * Ganada characters. * @remarks * [Api set: WordApiDesktop 1.1] */ ganada = "Ganada", /** + * Chosung characters. * @remarks * [Api set: WordApiDesktop 1.1] */ chosung = "Chosung", /** + * GBNum1 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ gbnum1 = "GBNum1", /** + * GBNum2 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ gbnum2 = "GBNum2", /** + * GBNum3 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ gbnum3 = "GBNum3", /** + * GBNum4 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ gbnum4 = "GBNum4", /** + * Zodiac1 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ zodiac1 = "Zodiac1", /** + * Zodiac2 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ zodiac2 = "Zodiac2", /** + * Zodiac3 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ zodiac3 = "Zodiac3", /** + * Traditional Chinese numbers (style 1). * @remarks * [Api set: WordApiDesktop 1.1] */ tradChinNum1 = "TradChinNum1", /** + * Traditional Chinese numbers (style 2). * @remarks * [Api set: WordApiDesktop 1.1] */ tradChinNum2 = "TradChinNum2", /** + * Traditional Chinese numbers (style 3). * @remarks * [Api set: WordApiDesktop 1.1] */ tradChinNum3 = "TradChinNum3", /** + * Traditional Chinese numbers (style 4). * @remarks * [Api set: WordApiDesktop 1.1] */ tradChinNum4 = "TradChinNum4", /** + * Simplified Chinese numbers (style 1). * @remarks * [Api set: WordApiDesktop 1.1] */ simpChinNum1 = "SimpChinNum1", /** + * Simplified Chinese numbers (style 2). * @remarks * [Api set: WordApiDesktop 1.1] */ simpChinNum2 = "SimpChinNum2", /** + * Simplified Chinese numbers (style 3). * @remarks * [Api set: WordApiDesktop 1.1] */ simpChinNum3 = "SimpChinNum3", /** + * Simplified Chinese numbers (style 4). * @remarks * [Api set: WordApiDesktop 1.1] */ simpChinNum4 = "SimpChinNum4", /** + * Hanja read numbers. * @remarks * [Api set: WordApiDesktop 1.1] */ hanjaRead = "HanjaRead", /** + * Hanja read digits. * @remarks * [Api set: WordApiDesktop 1.1] */ hanjaReadDigit = "HanjaReadDigit", /** + * Hangul characters. * @remarks * [Api set: WordApiDesktop 1.1] */ hangul = "Hangul", /** + * Hanja characters. * @remarks * [Api set: WordApiDesktop 1.1] */ hanja = "Hanja", /** + * Hebrew1 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ hebrew1 = "Hebrew1", /** + * Arabic1 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ arabic1 = "Arabic1", /** + * Hebrew2 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ hebrew2 = "Hebrew2", /** + * Arabic2 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ arabic2 = "Arabic2", /** + * Hindi letter style 1. * @remarks * [Api set: WordApiDesktop 1.1] */ hindiLetter1 = "HindiLetter1", /** + * Hindi letter style 2. * @remarks * [Api set: WordApiDesktop 1.1] */ hindiLetter2 = "HindiLetter2", /** + * Hindi Arabic style. * @remarks * [Api set: WordApiDesktop 1.1] */ hindiArabic = "HindiArabic", /** + * Hindi cardinal text. * @remarks * [Api set: WordApiDesktop 1.1] */ hindiCardinalText = "HindiCardinalText", /** + * Thai letter characters. * @remarks * [Api set: WordApiDesktop 1.1] */ thaiLetter = "ThaiLetter", /** + * Thai Arabic characters. * @remarks * [Api set: WordApiDesktop 1.1] */ thaiArabic = "ThaiArabic", /** + * Thai cardinal text. * @remarks * [Api set: WordApiDesktop 1.1] */ thaiCardinalText = "ThaiCardinalText", /** + * Vietnamese cardinal text. * @remarks * [Api set: WordApiDesktop 1.1] */ vietCardinalText = "VietCardinalText", /** + * Lowercase Russian. * @remarks * [Api set: WordApiDesktop 1.1] */ lowercaseRussian = "LowercaseRussian", /** + * Uppercase Russian. * @remarks * [Api set: WordApiDesktop 1.1] */ uppercaseRussian = "UppercaseRussian", /** + * Lowercase Greek. * @remarks * [Api set: WordApiDesktop 1.1] */ lowercaseGreek = "LowercaseGreek", /** + * Uppercase Greek. * @remarks * [Api set: WordApiDesktop 1.1] */ uppercaseGreek = "UppercaseGreek", /** + * Arabic numbers with leading zeros (style 2). * @remarks * [Api set: WordApiDesktop 1.1] */ arabicLZ2 = "ArabicLZ2", /** + * Arabic numbers with leading zeros (style 3). * @remarks * [Api set: WordApiDesktop 1.1] */ arabicLZ3 = "ArabicLZ3", /** + * Arabic numbers with leading zeros (style 4). * @remarks * [Api set: WordApiDesktop 1.1] */ arabicLZ4 = "ArabicLZ4", /** + * Lowercase Turkish. * @remarks * [Api set: WordApiDesktop 1.1] */ lowercaseTurkish = "LowercaseTurkish", /** + * Uppercase Turkish. * @remarks * [Api set: WordApiDesktop 1.1] */ uppercaseTurkish = "UppercaseTurkish", /** + * Lowercase Bulgarian. * @remarks * [Api set: WordApiDesktop 1.1] */ lowercaseBulgarian = "LowercaseBulgarian", /** + * Uppercase Bulgarian. * @remarks * [Api set: WordApiDesktop 1.1] */ uppercaseBulgarian = "UppercaseBulgarian", /** + * Picture bullet. * @remarks * [Api set: WordApiDesktop 1.1] */ pictureBullet = "PictureBullet", /** + * Legal numbering style. * @remarks * [Api set: WordApiDesktop 1.1] */ legal = "Legal", /** + * Legal numbering style with leading zeros. * @remarks * [Api set: WordApiDesktop 1.1] */ @@ -132852,7 +133195,7 @@ declare namespace Word { outsideMargin = "OutsideMargin", } /** - * Specifies the shape type for a `GeometricShape` object. + * Specifies the shape type for a {@link Word.GeometricShape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -133922,7 +134265,7 @@ declare namespace Word { chartPlus = "ChartPlus", } /** - * Specifies a shape's fill type. + * Specifies a {@link Word.Shape | shape's} fill type. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -134240,7 +134583,7 @@ declare namespace Word { exact = "Exact", } /** - * Specifies the border style for an object. + * Specifies the {@link Word.BorderUniversal | border } style for an object. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -134398,7 +134741,7 @@ declare namespace Word { inset = "Inset", } /** - * Specifies the width of an object's border. + * Specifies the width of an object's {@link Word.BorderUniversal | border}. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -137407,7 +137750,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. + * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `word97`. */ applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** @@ -137416,7 +137759,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. + * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `word97`. */ applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** @@ -137565,9 +137908,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; } /** @@ -137585,7 +137928,7 @@ declare namespace Word { */ level?: number; /** - * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. + * If provided, specifies the type of number to count. The default value is `paragraph`. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -137607,7 +137950,7 @@ declare namespace Word { */ applyLevel?: number; /** - * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. + * If provided, specifies which part of the list to apply the template to. The default value is `wholeList`. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -137621,7 +137964,7 @@ declare namespace Word { */ continuePreviousList?: boolean; /** - * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. + * If provided, specifies the default list behavior. The default value is `word97`. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -137919,9 +138262,9 @@ declare namespace Word { */ untrack(): Word.FillFormat; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.FillFormatData; } /** @@ -137992,9 +138335,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; } /** @@ -138150,9 +138493,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; } /** @@ -138237,9 +138580,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; } /** @@ -138324,9 +138667,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; } /** @@ -138472,9 +138815,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; } /** @@ -138812,9 +139155,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; } /** @@ -142246,9 +142589,9 @@ declare namespace Word { */ untrack(): Word.Bibliography; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BibliographyData; } /** @@ -142279,7 +142622,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a `Source` object. + * @param index The location of a `Source` object. */ getItem(index: number): Word.Source; /** @@ -142309,9 +142652,9 @@ declare namespace Word { */ untrack(): Word.SourceCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.SourceCollectionData; } /** @@ -142390,9 +142733,9 @@ declare namespace Word { */ untrack(): Word.Source; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.SourceData; } /** @@ -142666,9 +143009,9 @@ declare namespace Word { */ untrack(): Word.PageSetup; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.PageSetupData; } /** @@ -142753,9 +143096,9 @@ declare namespace Word { */ untrack(): Word.LineNumbering; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.LineNumberingData; } /** @@ -142872,9 +143215,9 @@ declare namespace Word { */ untrack(): Word.TextColumnCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TextColumnCollectionData; } /** @@ -142969,9 +143312,9 @@ declare namespace Word { */ untrack(): Word.TextColumn; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TextColumnData; } /** @@ -144536,7 +144879,7 @@ declare namespace Word { insertAsFullWidth?: boolean; } /** - * Represents the options for the {@link Word.Selection | Selection.insertFormula} method + * Represents the options for the {@link Word.Selection | Selection.insertFormula} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -144770,11 +145113,11 @@ declare namespace Word { } /** * Represents a selected range or the insertion point in a Word document. - - - Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] + * + * Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. * @beta */ class Selection extends OfficeExtension.ClientObject { @@ -145390,7 +145733,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param options Options for inserting the date or time. + * @param options Optional. Options for inserting the date or time. */ insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void; /** @@ -145679,7 +146022,7 @@ declare namespace Word { */ nextField(): Word.Field; /** - * Moves the selection to the next subDocument. + * Moves the selection to the next subdocument. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -145693,7 +146036,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param type The format paste type for table cells + * @param type The format paste type for table cells. */ pasteAndFormat(type: Word.PasteFormatType): void; /** @@ -145703,7 +146046,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param type The format paste type for table cells + * @param type The format paste type for table cells. */ pasteAndFormat(type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"): void; /** @@ -145752,7 +146095,7 @@ declare namespace Word { */ previousField(): Word.Field; /** - * Moves the selection to the previous subDocument. + * Moves the selection to the previous subdocument. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -145931,13 +146274,13 @@ declare namespace Word { */ untrack(): Word.Selection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Selection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Selection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.SelectionData; } /** - * Represents a collection of {@link Word.Range} objects that represents each character, word or sentence. + * Represents a collection of {@link Word.Range} objects that represents each character, word, or sentence. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -145955,7 +146298,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index The location of a `Range` object in the collection. + * @param index The location of a `Range` object. */ getItem(index: number): Word.Range; /** @@ -145985,9 +146328,9 @@ declare namespace Word { */ untrack(): Word.RangeScopedCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RangeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RangeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.RangeScopedCollectionData; } /** @@ -148296,9 +148639,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -148331,7 +148674,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a `Bookmark` object. + * @param index The location of a `Bookmark` object. */ getItem(index: number): Word.Bookmark; /** @@ -148361,9 +148704,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -148634,9 +148977,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -148677,7 +149020,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of an `Index` object. + * @param index The location of an `Index` object. */ getItem(index: number): Word.Index; /** @@ -148718,9 +149061,9 @@ declare namespace Word { */ 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. - */ + * 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; } /** @@ -148733,7 +149076,7 @@ declare namespace Word { 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`. + See `HeadingSeparator` for available values. The default value is `blankLine`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -148775,7 +149118,7 @@ declare namespace Word { */ 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`. + * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `stroke`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -148784,7 +149127,7 @@ declare namespace Word { 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`. + Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `indent`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -150028,7 +150371,7 @@ declare namespace Word { */ interface TableCellFormulaOptions { /** - * The mathematical formula you want the = (Formula) field to evaluate. Spreadsheet-type references to table cells are valid. For example, "=SUM(A4:C4)" specifies the first three values in the fourth row. For more information about the = (Formula) field, see {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Field codes: = (Formula) field}. + * If provided, specifies the mathematical formula you want the = (Formula) field to evaluate. Spreadsheet-type references to table cells are valid. For example, "=SUM(A4:C4)" specifies the first three values in the fourth row. For more information about the = (Formula) field, see {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Field codes: = (Formula) field}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -150036,7 +150379,7 @@ declare namespace Word { */ formula?: string; /** - * A format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}. For information about the types of formats you can apply, see the Numeric Picture (#) field switch. + * If provided, specifies a format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}. For information about the types of formats you can apply, see the Numeric Picture (#) field switch. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -150239,7 +150582,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index The zero-based index of the font name to retrieve. + * @param index The zero-based index of the item to retrieve. */ getItemAt(index: number): OfficeExtension.ClientResult; /** @@ -150266,9 +150609,9 @@ declare namespace Word { */ untrack(): Word.FontNameCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FontNameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontNameCollectionData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FontNameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontNameCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -150302,7 +150645,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a `ListTemplate` object. + * @param index The location of a `ListTemplate` object. */ getItem(index: number): Word.ListTemplate; /** @@ -150332,9 +150675,9 @@ declare namespace Word { */ untrack(): Word.ListTemplateCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListTemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ListTemplateCollectionData; } /** @@ -150404,9 +150747,9 @@ declare namespace Word { */ untrack(): Word.ListTemplateGallery; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListTemplateGallery` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateGallery` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListTemplateGalleryData; } /** @@ -150448,7 +150791,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a `ListTemplateGallery` object. + * @param index The location of a `ListTemplateGallery` object. */ getItem(index: number): Word.ListTemplateGallery; /** @@ -150472,9 +150815,9 @@ declare namespace Word { */ untrack(): Word.ListTemplateGalleryCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListTemplateGalleryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateGalleryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ListTemplateGalleryCollectionData; } /** @@ -150593,35 +150936,35 @@ declare namespace Word { } namespace Interfaces { /** - * Provides ways to load properties of only a subset of members of a collection. - */ + * 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. - */ + * 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. - */ + * Specify the number of items in the collection that are to be skipped and not included in the result. If `top` is specified, the selection of result will start after skipping the specified number of items. + */ $skip?: number; } /** An interface for updating data on the `Editor` object, for use in `editor.set({ ... })`. */ interface EditorUpdateData { /** - * Gets a `Range` object that represents the next range that the editor has permissions to modify. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ nextRange?: Word.Interfaces.RangeUpdateData; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeUpdateData; } /** An interface for updating data on the `ConflictCollection` object, for use in `conflictCollection.set({ ... })`. */ @@ -150631,12 +150974,12 @@ declare namespace Word { /** An interface for updating data on the `Conflict` object, for use in `conflict.set({ ... })`. */ interface ConflictUpdateData { /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeUpdateData; } /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ @@ -150646,11 +150989,11 @@ declare namespace Word { /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ interface ApplicationUpdateData { /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyUpdateData; /** * Specifies if Microsoft Word automatically detects the language you are using as you type. @@ -150663,11 +151006,11 @@ declare namespace Word { /** 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] - */ + * 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. @@ -150770,7 +151113,7 @@ declare namespace Word { /** 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. + * 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] @@ -150791,7 +151134,7 @@ declare namespace Word { */ 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. + * 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] @@ -150820,11 +151163,11 @@ declare namespace Word { /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ interface BreakUpdateData { /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; } /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ @@ -150875,12 +151218,12 @@ declare namespace Word { /** An interface for updating data on the `CoauthoringLock` object, for use in `coauthoringLock.set({ ... })`. */ interface CoauthoringLockUpdateData { /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeUpdateData; } /** An interface for updating data on the `CoauthoringLockCollection` object, for use in `coauthoringLockCollection.set({ ... })`. */ @@ -150894,12 +151237,12 @@ declare namespace Word { /** An interface for updating data on the `CoauthoringUpdate` object, for use in `coauthoringUpdate.set({ ... })`. */ interface CoauthoringUpdateUpdateData { /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeUpdateData; } /** An interface for updating data on the `CoauthoringUpdateCollection` object, for use in `coauthoringUpdateCollection.set({ ... })`. */ @@ -150909,11 +151252,11 @@ declare namespace Word { /** 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] - */ + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeUpdateData; /** * Specifies the comment's content as plain text. @@ -150923,7 +151266,7 @@ declare namespace Word { */ 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. + * 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] @@ -150965,7 +151308,7 @@ declare namespace Word { */ strikeThrough?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * 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] @@ -150975,18 +151318,18 @@ declare namespace Word { /** 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] - */ + * 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] - */ + * 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. @@ -151038,18 +151381,18 @@ declare namespace Word { /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ interface XmlMappingUpdateData { /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; } /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ @@ -151067,12 +151410,12 @@ declare namespace Word { /** 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 - */ + * 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({ ... })`. */ @@ -151082,46 +151425,46 @@ declare namespace Word { /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ interface CustomXmlNodeUpdateData { /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; /** - * Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; /** * Specifies the value of the current node. @@ -151141,70 +151484,70 @@ declare namespace Word { /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ interface ContentControlUpdateData { /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontUpdateData; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks * [Api set: WordApi 1.1] @@ -151232,21 +151575,21 @@ declare namespace Word { */ placeholderText?: string; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ removeWhenEdited?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * 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. + * 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] @@ -151316,11 +151659,11 @@ declare namespace Word { /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ interface CustomXmlPartUpdateData { /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; } /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ @@ -151334,39 +151677,39 @@ declare namespace Word { /** 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] - */ + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ activeWindow?: Word.Interfaces.WindowUpdateData; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyUpdateData; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyUpdateData; /** - * Returns a `PageSetup` object that's associated with the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupUpdateData; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesUpdateData; /** * Specifies whether grammatical errors are marked by a wavy green line in the document. @@ -151913,23 +152256,23 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlSaveThroughXSLT?: string; + xmlSaveThroughXslt?: string; } /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ interface DocumentCreatedUpdateData { /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ + * 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] - */ + * 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({ ... })`. */ @@ -152001,11 +152344,11 @@ declare namespace Word { /** 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] - */ + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ result?: Word.Interfaces.RangeUpdateData; /** * Specifies the field's code instruction. @@ -152017,7 +152360,7 @@ declare namespace Word { */ 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. + * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks * [Api set: WordApi 1.5] @@ -152045,53 +152388,53 @@ declare namespace Word { /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ interface FontUpdateData { /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ fill?: Word.Interfaces.FillFormatUpdateData; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ glow?: Word.Interfaces.GlowFormatUpdateData; /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ line?: Word.Interfaces.LineFormatUpdateData; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ reflection?: Word.Interfaces.ReflectionFormatUpdateData; /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textShadow?: Word.Interfaces.ShadowFormatUpdateData; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; /** * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: @@ -152107,7 +152450,7 @@ declare namespace Word { */ allCaps?: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -152127,7 +152470,7 @@ declare namespace Word { */ boldBidirectional?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApi 1.1] @@ -152169,7 +152512,7 @@ declare namespace Word { */ 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. + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -152209,21 +152552,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hidden?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * 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. + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -152257,7 +152600,7 @@ declare namespace Word { */ 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. + * Specifies the name of the font. * * @remarks * [Api set: WordApi 1.1] @@ -152346,7 +152689,7 @@ declare namespace Word { */ shadow?: boolean; /** - * Specifies a value that represents the font size in points. + * Specifies the font size in points. * * @remarks * [Api set: WordApi 1.1] @@ -152380,7 +152723,7 @@ declare namespace Word { */ spacing?: number; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -152394,21 +152737,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ subscript?: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ superscript?: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies the font's underline type. `none` if the font isn't underlined. * * @remarks * [Api set: WordApi 1.1] @@ -152448,11 +152791,11 @@ declare namespace Word { /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ interface HyperlinkUpdateData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** * Specifies the address (for example, a file name or URL) of the hyperlink. @@ -152602,77 +152945,77 @@ declare namespace Word { /** 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] - */ + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontUpdateData; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * 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. + * Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ linkedStyle?: string; /** - * Specifies the number format for the specified list level. + * Specifies the number format for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberFormat?: string; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberPosition?: number; /** - * Specifies the number style for the list level object. + * Specifies the number style for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the list level that must appear before it restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ resetOnHigher?: number; /** - * Specifies the starting number for the specified list level object. + * Specifies the starting number for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ startAt?: number; /** - * Specifies the tab position for the specified list level object. + * Specifies the tab position for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ tabPosition?: number; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ textPosition?: number; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the character inserted after the number for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -152704,18 +153047,18 @@ declare namespace Word { /** 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] - */ + * 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] - */ + * 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({ ... })`. */ @@ -152776,20 +153119,20 @@ declare namespace Word { /** 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 - */ + * 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 - */ + * 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. @@ -152840,7 +153183,7 @@ declare namespace Word { */ isDocumentMapVisible?: boolean; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -152951,35 +153294,35 @@ declare namespace Word { /** 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] - */ + * 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] - */ + * 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] - */ + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.1] @@ -153171,25 +153514,25 @@ declare namespace Word { /** 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] - */ + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontUpdateData; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listFormat?: Word.Interfaces.ListFormatUpdateData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalUpdateData; /** * Specifies a `CharacterCase` value that represents the case of the text in the range. @@ -153359,49 +153702,49 @@ declare namespace Word { /** 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. + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignorePunct?: boolean; /** - * 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. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignoreSpace?: boolean; /** - * 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. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchCase?: boolean; /** - * 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. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchPrefix?: boolean; /** - * 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. + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchSuffix?: boolean; /** - * 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. + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchWholeWord?: boolean; /** - * 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. + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] @@ -153411,18 +153754,18 @@ declare namespace Word { /** 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] - */ + * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyUpdateData; /** - * Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupUpdateData; /** * Specifies if the section is protected for forms. @@ -153457,60 +153800,60 @@ declare namespace Word { /** 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] - */ + * Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderCollectionUpdateData; /** - * Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontUpdateData; /** - * Returns a `Frame` object that represents the frame formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frame?: Word.Interfaces.FrameUpdateData; /** - * Specifies a link between a paragraph and a character style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ linkStyle?: Word.Interfaces.StyleUpdateData; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `ListTemplate` object that represents the list formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingUpdateData; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * 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. @@ -153557,7 +153900,7 @@ declare namespace Word { */ 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. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks * [Api set: WordApi 1.5] @@ -153587,14 +153930,14 @@ declare namespace Word { */ 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. + * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks * [Api set: WordApi 1.5] */ unhideWhenUsed?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] @@ -153666,14 +154009,14 @@ declare namespace Word { /** 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] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontUpdateData; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApi 1.3] @@ -153695,7 +154038,7 @@ declare namespace Word { */ headerRowCount?: number; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] @@ -153773,7 +154116,7 @@ declare namespace Word { */ values?: string[][]; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -153797,7 +154140,7 @@ declare namespace Word { */ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -153890,11 +154233,11 @@ declare namespace Word { /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ interface TableColumnUpdateData { /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalUpdateData; /** * Specifies the preferred width (in points or as a percentage of the window width) for the column. @@ -154216,14 +154559,14 @@ declare namespace Word { /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ interface TableRowUpdateData { /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontUpdateData; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -154251,7 +154594,7 @@ declare namespace Word { */ values?: string[][]; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -154265,11 +154608,11 @@ declare namespace Word { /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ interface TableCellUpdateData { /** - * Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyUpdateData; /** * Specifies the width of the cell's column in points. This is applicable to uniform tables. @@ -154279,7 +154622,7 @@ declare namespace Word { */ columnWidth?: number; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -154300,7 +154643,7 @@ declare namespace Word { */ value?: string; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -154694,60 +155037,60 @@ declare namespace Word { /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ interface ShapeUpdateData { /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ body?: Word.Interfaces.BodyUpdateData; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ canvas?: Word.Interfaces.CanvasUpdateData; /** - * Returns the fill formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the fill formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ fill?: Word.Interfaces.ShapeFillUpdateData; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentCanvas?: Word.Interfaces.ShapeUpdateData; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentGroup?: Word.Interfaces.ShapeUpdateData; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; /** - * Gets the text frame object of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `TextFrame` object of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textFrame?: Word.Interfaces.TextFrameUpdateData; /** - * Returns the text wrap formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; /** * Specifies whether a given shape can overlap other shapes. @@ -154886,21 +155229,21 @@ declare namespace Word { /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ interface ShapeGroupUpdateData { /** - * Gets the Shape object associated with the group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeUpdateData; } /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ interface CanvasUpdateData { /** - * Gets the Shape object associated with the canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeUpdateData; } /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ @@ -154934,56 +155277,56 @@ declare namespace Word { /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ interface TextFrameUpdateData { /** - * 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 automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks * [Api set: WordApiDesktop 1.2] */ autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the bottom margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ bottomMargin?: number; /** - * Represents the left margin, in points, of the text frame. + * Specifies the left margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ leftMargin?: number; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. * * @remarks * [Api set: WordApiDesktop 1.2] */ noTextRotation?: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks * [Api set: WordApiDesktop 1.2] */ orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Represents the right margin, in points, of the text frame. + * Specifies the right margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ rightMargin?: number; /** - * Represents the top margin, in points, of the text frame. + * Specifies the top margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ topMargin?: number; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -155079,30 +155422,30 @@ declare namespace Word { /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ interface RepeatingSectionItemUpdateData { /** - * Returns the range of this repeating section item, excluding the start and end tags. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; } /** An interface for updating data on the `Revision` object, for use in `revision.set({ ... })`. */ interface RevisionUpdateData { /** - * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ movedRange?: Word.Interfaces.RangeUpdateData; /** - * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeUpdateData; } /** An interface for updating data on the `RevisionCollection` object, for use in `revisionCollection.set({ ... })`. */ @@ -155112,25 +155455,25 @@ declare namespace Word { /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ interface DatePickerContentControlUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** * Specifies the appearance of the content control. @@ -155213,25 +155556,25 @@ declare namespace Word { /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ interface PictureContentControlUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** * Specifies the appearance of the content control. @@ -155286,25 +155629,25 @@ declare namespace Word { /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ interface GroupContentControlUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** * Specifies the appearance of the content control. @@ -155359,25 +155702,25 @@ declare namespace Word { /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ interface BuildingBlockGalleryContentControlUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** * Specifies the appearance of the content control. @@ -155446,26 +155789,26 @@ declare namespace Word { /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ interface RepeatingSectionContentControlUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * 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 - */ + * 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.XmlMappingUpdateData; /** * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. @@ -155683,18 +156026,18 @@ declare namespace Word { /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ interface FrameUpdateData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalUpdateData; /** * Specifies the height (in points) of the frame. @@ -155792,11 +156135,11 @@ declare namespace Word { /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ interface ListFormatUpdateData { /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** * Specifies the list level number for the first paragraph for the `ListFormat` object. @@ -155809,18 +156152,18 @@ declare namespace Word { /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ interface FillFormatUpdateData { /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. @@ -155896,11 +156239,11 @@ declare namespace Word { /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ interface GlowFormatUpdateData { /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ color?: Word.Interfaces.ColorFormatUpdateData; /** * Specifies the length of the radius for a glow effect. @@ -155920,18 +156263,18 @@ declare namespace Word { /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ interface LineFormatUpdateData { /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** * Specifies the length of the arrowhead at the beginning of the line. @@ -156097,11 +156440,11 @@ declare namespace Word { /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ interface ShadowFormatUpdateData { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. @@ -156180,18 +156523,18 @@ declare namespace Word { /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ interface ThreeDimensionalFormatUpdateData { /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ contourColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ extrusionColor?: Word.Interfaces.ColorFormatUpdateData; /** * Specifies the depth of the bottom bevel. @@ -156367,11 +156710,11 @@ declare namespace Word { /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ interface PageSetupUpdateData { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lineNumbering?: Word.Interfaces.LineNumberingUpdateData; /** * Specifies whether Microsoft Word prints the document as a booklet. @@ -156711,12 +157054,12 @@ declare namespace Word { /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ interface BookmarkUpdateData { /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * 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.RangeUpdateData; /** * Specifies the ending character position of the bookmark. @@ -156742,12 +157085,12 @@ declare namespace Word { /** An interface for updating data on the `Index` object, for use in `index.set({ ... })`. */ interface IndexUpdateData { /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * 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.RangeUpdateData; /** * Specifies the leader character between entries in the index and their associated page numbers. @@ -156773,20 +157116,20 @@ declare namespace Word { /** An interface describing the data returned by calling `editor.toJSON()`. */ interface EditorData { /** - * Gets a `Range` object that represents the next range that the editor has permissions to modify. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ nextRange?: Word.Interfaces.RangeData; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeData; /** * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. @@ -156812,12 +157155,12 @@ declare namespace Word { /** An interface describing the data returned by calling `conflict.toJSON()`. */ interface ConflictData { /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeData; /** * Gets the `RevisionType` for the `Conflict` object. @@ -156841,7 +157184,7 @@ declare namespace Word { /** An interface describing the data returned by calling `annotation.toJSON()`. */ interface AnnotationData { /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. * * @remarks * [Api set: WordApi 1.7] @@ -156862,19 +157205,19 @@ declare namespace Word { /** An interface describing the data returned by calling `application.toJSON()`. */ interface ApplicationData { /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyData; /** - * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ listTemplateGalleries?: Word.Interfaces.ListTemplateGalleryData[]; /** * Specifies if Microsoft Word automatically detects the language you are using as you type. @@ -156894,62 +157237,64 @@ declare namespace Word { /** An interface describing the data returned by calling `body.toJSON()`. */ interface BodyData { /** - * Gets the collection of rich text content control objects in the body. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of rich text content control objects in the body. + * + * @remarks + * [Api set: WordApi 1.1] + */ contentControls?: Word.Interfaces.ContentControlData[]; /** - * Gets the collection of field objects in the body. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of `Field` objects in the body. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontData; /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `InlinePicture` objects in the body. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the collection of list objects in the body. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of `List` objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ lists?: Word.Interfaces.ListData[]; /** - * Gets the collection of paragraph objects in the body. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. - */ + * Gets the collection of `Paragraph` objects in the body. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. + */ paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of `Shape` objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + */ shapes?: Word.Interfaces.ShapeData[]; /** - * Gets the collection of table objects in the body. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of `Table` objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ tables?: Word.Interfaces.TableData[]; /** * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. @@ -156973,7 +157318,7 @@ declare namespace Word { */ text?: string; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * Gets the type of the body. The type can be `mainDoc`, `section`, `header`, `footer`, or `tableCell`. Additional types `footnote`, `endnote`, and `noteItem` are supported in WordApi 1.5 and later. * * @remarks * [Api set: WordApi 1.3] @@ -157088,11 +157433,11 @@ declare namespace Word { /** An interface describing the data returned by calling `break.toJSON()`. */ interface BreakData { /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** * Returns the page number on which the break occurs. @@ -157198,20 +157543,20 @@ declare namespace Word { /** An interface describing the data returned by calling `coauthoringLock.toJSON()`. */ interface CoauthoringLockData { /** - * Gets the owner of the lock. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the owner of the lock. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ owner?: Word.Interfaces.CoauthorData; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeData; /** * Gets a `CoauthoringLockType` value that represents the lock type. @@ -157229,12 +157574,12 @@ declare namespace Word { /** An interface describing the data returned by calling `coauthor.toJSON()`. */ interface CoauthorData { /** - * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ locks?: Word.Interfaces.CoauthoringLockData[]; /** * Gets the email address of the coauthor. @@ -157276,44 +157621,44 @@ declare namespace Word { /** An interface describing the data returned by calling `coauthoring.toJSON()`. */ interface CoauthoringData { /** - * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ authors?: Word.Interfaces.CoauthorData[]; /** - * Gets a `ConflictCollection` object that represents all the conflicts in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `ConflictCollection` object that represents all the conflicts in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ conflicts?: Word.Interfaces.ConflictData[]; /** - * Gets a `CoauthoringLockCollection` object that represents the locks in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `CoauthoringLockCollection` object that represents the locks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ locks?: Word.Interfaces.CoauthoringLockData[]; /** - * Gets a `Coauthor` object that represents the current user. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Coauthor` object that represents the current user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ me?: Word.Interfaces.CoauthorData; /** - * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ updates?: Word.Interfaces.CoauthoringUpdateData[]; /** * Gets whether this document can be coauthored. @@ -157343,12 +157688,12 @@ declare namespace Word { /** An interface describing the data returned by calling `coauthoringUpdate.toJSON()`. */ interface CoauthoringUpdateData { /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeData; } /** An interface describing the data returned by calling `coauthoringUpdateCollection.toJSON()`. */ @@ -157358,18 +157703,18 @@ declare namespace Word { /** An interface describing the data returned by calling `comment.toJSON()`. */ interface CommentData { /** - * Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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] - */ + * 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. @@ -157407,7 +157752,7 @@ declare namespace Word { */ id?: string; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * 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] @@ -157463,7 +157808,7 @@ declare namespace Word { */ text?: string; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * 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] @@ -157564,18 +157909,18 @@ declare namespace Word { /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ interface XmlMappingData { /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlNode?: Word.Interfaces.CustomXmlNodeData; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlPart?: Word.Interfaces.CustomXmlPartData; /** * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. @@ -157648,12 +157993,12 @@ declare namespace Word { /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ interface CustomXmlValidationErrorData { /** - * 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 - */ + * 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.CustomXmlNodeData; /** * Gets an integer representing the validation error in the `CustomXmlValidationError` object. @@ -157695,60 +158040,60 @@ declare namespace Word { /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ interface CustomXmlNodeData { /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ attributes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ childNodes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ firstChild?: Word.Interfaces.CustomXmlNodeData; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lastChild?: Word.Interfaces.CustomXmlNodeData; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ nextSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ ownerPart?: Word.Interfaces.CustomXmlPartData; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ parentNode?: Word.Interfaces.CustomXmlNodeData; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ previousSibling?: Word.Interfaces.CustomXmlNodeData; /** * Gets the base name of the node without the namespace prefix, if one exists. @@ -157803,128 +158148,128 @@ declare namespace Word { /** An interface describing the data returned by calling `contentControl.toJSON()`. */ interface ContentControlData { /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; /** - * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.9] - */ + * Gets the data of the content control when its type is `comboBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** - * Gets the collection of content control objects in the content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `ContentControl` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ contentControls?: Word.Interfaces.ContentControlData[]; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; /** - * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.9] - */ + * Gets the data of the content control when its type is `dropDownList`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** - * Gets the collection of field objects in the content control. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of `Field` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontData; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ groupContentControl?: Word.Interfaces.GroupContentControlData; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `InlinePicture` objects in the content control. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the collection of list objects in the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of `List` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ lists?: Word.Interfaces.ListData[]; /** - * Gets the collection of paragraph objects in the content control. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. - */ + * Gets the collection of `Paragraph` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + */ paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pictureContentControl?: Word.Interfaces.PictureContentControlData; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; /** - * Gets the collection of table objects in the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of `Table` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ tables?: Word.Interfaces.TableData[]; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks * [Api set: WordApi 1.1] @@ -157959,28 +158304,28 @@ declare namespace Word { */ placeholderText?: string; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ removeWhenEdited?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * 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. + * 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. + * Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. * * @remarks * [Api set: WordApi 1.3] @@ -158008,7 +158353,7 @@ declare namespace Word { */ title?: string; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. * * @remarks * [Api set: WordApi 1.1] @@ -158078,33 +158423,33 @@ declare namespace Word { /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ interface CustomXmlPartData { /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentElement?: Word.Interfaces.CustomXmlNodeData; /** - * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ errors?: Word.Interfaces.CustomXmlValidationErrorData[]; /** - * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; /** - * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; /** * Gets a value that indicates whether the `CustomXmlPart` is built-in. @@ -158146,119 +158491,119 @@ declare namespace Word { /** An interface describing the data returned by calling `document.toJSON()`. */ interface DocumentData { /** - * Gets the active window for the document. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ activeWindow?: Word.Interfaces.WindowData; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyData; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyData; /** - * Gets a `Coauthoring` object for managing coauthoring in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Coauthoring` object for managing coauthoring in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ coauthoring?: Word.Interfaces.CoauthoringData; /** - * 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 1.1] - */ + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ contentControls?: Word.Interfaces.ContentControlData[]; /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ customXmlParts?: Word.Interfaces.CustomXmlPartData[]; /** - * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; /** - * Returns a `FrameCollection` object that represents all the frames in the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `FrameCollection` object that represents all the frames in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frames?: Word.Interfaces.FrameData[]; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Returns a `ListTemplateCollection` object that represents all the list templates in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ListTemplateCollection` object that represents all the list templates in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ listTemplates?: Word.Interfaces.ListTemplateData[]; /** - * Returns a `PageSetup` object that's associated with the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupData; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesData; /** - * Gets the collection of section objects in the document. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `Section` objects in the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ sections?: Word.Interfaces.SectionData[]; /** - * Returns a `Selection` object that represents the current selection in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `Selection` object that represents the current selection in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ selection?: Word.Interfaces.SelectionData; /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ settings?: Word.Interfaces.SettingData[]; /** - * Gets the collection of `Word.Window` objects for the document. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of `Word.Window` objects for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ windows?: Word.Interfaces.WindowData[]; /** * Gets the name of the active theme and formatting options. @@ -158927,7 +159272,7 @@ declare namespace Word { */ saveFormat?: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * 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] @@ -159020,19 +159365,19 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlSaveThroughXSLT?: string; + xmlSaveThroughXslt?: string; } /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ interface DocumentCreatedData { /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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. + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -159053,7 +159398,7 @@ declare namespace Word { */ properties?: Word.Interfaces.DocumentPropertiesData; /** - * Gets the collection of section objects in the document. + * Gets the collection of `Section` objects in the document. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -159067,7 +159412,7 @@ declare namespace Word { */ settings?: Word.Interfaces.SettingData[]; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -159228,7 +159573,7 @@ declare namespace Word { */ 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. + * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks * [Api set: WordApi 1.5] @@ -159270,60 +159615,60 @@ declare namespace Word { /** An interface describing the data returned by calling `font.toJSON()`. */ interface FontData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ fill?: Word.Interfaces.FillFormatData; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ glow?: Word.Interfaces.GlowFormatData; /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ line?: Word.Interfaces.LineFormatData; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ reflection?: Word.Interfaces.ReflectionFormatData; /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textColor?: Word.Interfaces.ColorFormatData; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textShadow?: Word.Interfaces.ShadowFormatData; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; /** * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: @@ -159339,7 +159684,7 @@ declare namespace Word { */ allCaps?: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -159359,7 +159704,7 @@ declare namespace Word { */ boldBidirectional?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApi 1.1] @@ -159401,7 +159746,7 @@ declare namespace Word { */ 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. + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -159441,21 +159786,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hidden?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * 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. + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -159489,7 +159834,7 @@ declare namespace Word { */ 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. + * Specifies the name of the font. * * @remarks * [Api set: WordApi 1.1] @@ -159578,7 +159923,7 @@ declare namespace Word { */ shadow?: boolean; /** - * Specifies a value that represents the font size in points. + * Specifies the font size in points. * * @remarks * [Api set: WordApi 1.1] @@ -159612,7 +159957,7 @@ declare namespace Word { */ spacing?: number; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -159626,21 +159971,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ subscript?: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ superscript?: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies the font's underline type. `none` if the font isn't underlined. * * @remarks * [Api set: WordApi 1.1] @@ -159680,11 +160025,11 @@ declare namespace Word { /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ interface HyperlinkData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** * Specifies the address (for example, a file name or URL) of the hyperlink. @@ -159879,21 +160224,21 @@ declare namespace Word { */ paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the list's id. + * Gets the list's ID. * * @remarks * [Api set: WordApi 1.3] */ id?: 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. + * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks * [Api set: WordApi 1.3] */ levelExistences?: boolean[]; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. * * @remarks * [Api set: WordApi 1.3] @@ -159931,77 +160276,77 @@ declare namespace Word { /** An interface describing the data returned by calling `listLevel.toJSON()`. */ interface ListLevelData { /** - * Gets a Font object that represents the character formatting of the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontData; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * 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. + * Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ linkedStyle?: string; /** - * Specifies the number format for the specified list level. + * Specifies the number format for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberFormat?: string; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberPosition?: number; /** - * Specifies the number style for the list level object. + * Specifies the number style for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the list level that must appear before it restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ resetOnHigher?: number; /** - * Specifies the starting number for the specified list level object. + * Specifies the starting number for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ startAt?: number; /** - * Specifies the tab position for the specified list level object. + * Specifies the tab position for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ tabPosition?: number; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ textPosition?: number; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the character inserted after the number for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -160015,11 +160360,11 @@ declare namespace Word { /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ interface ListTemplateData { /** - * Gets a `ListLevelCollection` object that represents all the levels for the list template. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `ListLevelCollection` object that represents all the levels for the list template. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listLevels?: Word.Interfaces.ListLevelData[]; /** * Specifies the name of the list template. @@ -160040,18 +160385,18 @@ declare namespace Word { /** An interface describing the data returned by calling `noteItem.toJSON()`. */ interface NoteItemData { /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ body?: Word.Interfaces.BodyData; /** - * Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ reference?: Word.Interfaces.RangeData; /** * Represents the note item type: footnote or endnote. @@ -160143,11 +160488,11 @@ declare namespace Word { /** An interface describing the data returned by calling `page.toJSON()`. */ interface PageData { /** - * Gets a `BreakCollection` object that represents the breaks on the page. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `BreakCollection` object that represents the breaks on the page. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ breaks?: Word.Interfaces.BreakData[]; /** * Gets the height, in points, of the paper defined in the Page Setup dialog box. @@ -160178,18 +160523,18 @@ declare namespace Word { /** An interface describing the data returned by calling `pane.toJSON()`. */ interface PaneData { /** - * Gets the collection of pages in the pane. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of pages in the pane. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ pages?: Word.Interfaces.PageData[]; /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ pagesEnclosingViewport?: Word.Interfaces.PageData[]; } /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ @@ -160199,20 +160544,20 @@ declare namespace Word { /** An interface describing the data returned by calling `window.toJSON()`. */ interface WindowData { /** - * Gets the next document window in the collection of open document windows. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the next document window in the collection of open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ next?: Word.Interfaces.WindowData; /** - * Gets the previous document window in the collection open document windows. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the previous document window in the collection open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ previous?: Word.Interfaces.WindowData; /** * Specifies whether rulers are displayed for the window or pane. @@ -160295,7 +160640,7 @@ declare namespace Word { */ isDocumentMapVisible?: boolean; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -160462,63 +160807,65 @@ declare namespace Word { /** An interface describing the data returned by calling `paragraph.toJSON()`. */ interface ParagraphData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Gets the collection of fields in the paragraph. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of fields in the paragraph. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontData; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `InlinePicture` objects in the paragraph. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItem?: Word.Interfaces.ListItemData; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItemOrNullObject?: Word.Interfaces.ListItemData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalData; /** - * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of `Shape` objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + */ shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.1] @@ -160745,97 +161092,99 @@ declare namespace Word { /** An interface describing the data returned by calling `range.toJSON()`. */ interface RangeData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ conflicts?: Word.Interfaces.ConflictData[]; /** - * Gets the collection of field objects in the range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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 range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * 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 a `FrameCollection` object that represents all the frames in the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `FrameCollection` object that represents all the frames in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frames?: Word.Interfaces.FrameData[]; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Gets the collection of inline picture objects in the range. - * - * @remarks - * [Api set: WordApi 1.2] - */ + * Gets the collection of `InlinePicture` objects in the range. + * + * @remarks + * [Api set: WordApi 1.2] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listFormat?: Word.Interfaces.ListFormatData; /** - * Gets the collection of pages in the range. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of pages in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ pages?: Word.Interfaces.PageData[]; /** - * Gets the collection of sections in the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the collection of sections in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ sections?: Word.Interfaces.SectionData[]; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalData; /** - * 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: WordApiDesktop 1.2] - */ + * 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: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + */ shapes?: Word.Interfaces.ShapeData[]; /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ tableColumns?: Word.Interfaces.TableColumnData[]; /** * Specifies whether the range is formatted as bold. @@ -161115,49 +161464,49 @@ declare namespace Word { /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ interface SearchOptionsData { /** - * 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. + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignorePunct?: boolean; /** - * 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. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignoreSpace?: boolean; /** - * 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. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchCase?: boolean; /** - * 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. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchPrefix?: boolean; /** - * 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. + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchSuffix?: boolean; /** - * 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. + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchWholeWord?: boolean; /** - * 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. + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] @@ -161167,25 +161516,25 @@ declare namespace Word { /** An interface describing the data returned by calling `section.toJSON()`. */ interface SectionData { /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * 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.BodyData; /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupData; /** * Specifies if the section is protected for forms. @@ -161227,60 +161576,60 @@ declare namespace Word { /** An interface describing the data returned by calling `style.toJSON()`. */ interface StyleData { /** - * Specifies a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderData[]; /** - * Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontData; /** - * Returns a `Frame` object that represents the frame formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frame?: Word.Interfaces.FrameData; /** - * Specifies a link between a paragraph and a character style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ linkStyle?: Word.Interfaces.StyleData; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `ListTemplate` object that represents the list formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateData; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatData; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingData; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a `TableStyle` object representing style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ tableStyle?: Word.Interfaces.TableStyleData; /** * Specifies whether the style is automatically redefined based on the selection. @@ -161299,14 +161648,14 @@ declare namespace Word { */ baseStyle?: string; /** - * Gets whether the specified style is a built-in style. + * Gets whether the style is a built-in style. * * @remarks * [Api set: WordApi 1.5] */ builtIn?: boolean; /** - * Gets the description of the specified style. + * Gets the description of the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -161321,7 +161670,7 @@ declare namespace Word { */ hasProofing?: boolean; /** - * 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. + * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks * [Api set: WordApi 1.5] @@ -161342,7 +161691,7 @@ declare namespace Word { */ 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 whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks * [Api set: WordApi 1.5] @@ -161363,14 +161712,14 @@ declare namespace Word { */ locked?: boolean; /** - * Gets the name of a style in the language of the user. + * Gets the name of the style in the language of the user. * * @remarks * [Api set: WordApi 1.5] */ nameLocal?: string; /** - * 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 name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks * [Api set: WordApi 1.5] @@ -161407,14 +161756,14 @@ declare namespace Word { */ type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * 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 whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks * [Api set: WordApi 1.5] */ unhideWhenUsed?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] @@ -161486,35 +161835,35 @@ declare namespace Word { /** An interface describing the data returned by calling `table.toJSON()`. */ interface TableData { /** - * Gets the collection of field objects in the table. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of `Field` objects in the table. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontData; /** - * Gets all of the table rows. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets all of the table rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ rows?: Word.Interfaces.TableRowData[]; /** - * Gets the child tables nested one level deeper. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the child tables nested one level deeper. + * + * @remarks + * [Api set: WordApi 1.3] + */ tables?: Word.Interfaces.TableData[]; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApi 1.3] @@ -161536,7 +161885,7 @@ declare namespace Word { */ headerRowCount?: number; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] @@ -161635,7 +161984,7 @@ declare namespace Word { */ values?: string[][]; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -161659,7 +162008,7 @@ declare namespace Word { */ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -161787,18 +162136,18 @@ declare namespace Word { /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ interface TableColumnData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalData; /** * Returns the position of this column in a collection. @@ -162167,7 +162516,7 @@ declare namespace Word { */ cells?: Word.Interfaces.TableCellData[]; /** - * Gets the collection of field objects in the table row. + * Gets the collection of `Field` objects in the table row. * * @remarks * [Api set: WordApi 1.4] @@ -162188,14 +162537,14 @@ declare namespace Word { */ cellCount?: number; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] */ horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks * [Api set: WordApi 1.3] @@ -162230,7 +162579,7 @@ declare namespace Word { */ values?: string[][]; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -162244,11 +162593,11 @@ declare namespace Word { /** An interface describing the data returned by calling `tableCell.toJSON()`. */ interface TableCellData { /** - * Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyData; /** * Gets the index of the cell in its row. @@ -162265,7 +162614,7 @@ declare namespace Word { */ columnWidth?: number; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -162293,7 +162642,7 @@ declare namespace Word { */ value?: string; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -162889,60 +163238,60 @@ declare namespace Word { /** An interface describing the data returned by calling `shape.toJSON()`. */ interface ShapeData { /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ body?: Word.Interfaces.BodyData; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ canvas?: Word.Interfaces.CanvasData; /** - * Returns the fill formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the fill formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ fill?: Word.Interfaces.ShapeFillData; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentCanvas?: Word.Interfaces.ShapeData; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentGroup?: Word.Interfaces.ShapeData; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapeGroup?: Word.Interfaces.ShapeGroupData; /** - * Gets the text frame object of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `TextFrame` object of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textFrame?: Word.Interfaces.TextFrameData; /** - * Returns the text wrap formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textWrap?: Word.Interfaces.ShapeTextWrapData; /** * Specifies whether a given shape can overlap other shapes. @@ -163102,18 +163451,18 @@ declare namespace Word { /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ interface ShapeGroupData { /** - * Gets the Shape object associated with the group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeData; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of `Shape` objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapes?: Word.Interfaces.ShapeData[]; /** * Gets an integer that represents the shape group identifier. @@ -163126,18 +163475,18 @@ declare namespace Word { /** An interface describing the data returned by calling `canvas.toJSON()`. */ interface CanvasData { /** - * Gets the Shape object associated with the canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeData; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of {@link Word.Shape} objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapes?: Word.Interfaces.ShapeData[]; /** * Gets an integer that represents the canvas identifier. @@ -163185,63 +163534,63 @@ declare namespace Word { /** An interface describing the data returned by calling `textFrame.toJSON()`. */ interface TextFrameData { /** - * 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 automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks * [Api set: WordApiDesktop 1.2] */ autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the bottom margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ bottomMargin?: number; /** - * Specifies if the text frame contains text. + * Returns `true` if the text frame contains text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hasText?: boolean; /** - * Represents the left margin, in points, of the text frame. + * Specifies the left margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ leftMargin?: number; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. * * @remarks * [Api set: WordApiDesktop 1.2] */ noTextRotation?: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks * [Api set: WordApiDesktop 1.2] */ orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Represents the right margin, in points, of the text frame. + * Specifies the right margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ rightMargin?: number; /** - * Represents the top margin, in points, of the text frame. + * Specifies the top margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ topMargin?: number; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163337,30 +163686,30 @@ declare namespace Word { /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ interface RepeatingSectionItemData { /** - * Returns the range of this repeating section item, excluding the start and end tags. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; } /** An interface describing the data returned by calling `revision.toJSON()`. */ interface RevisionData { /** - * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ movedRange?: Word.Interfaces.RangeData; /** - * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeData; /** * Gets the name of the user who made the tracked change. @@ -163410,25 +163759,25 @@ declare namespace Word { /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ interface DatePickerContentControlData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. @@ -163532,25 +163881,25 @@ declare namespace Word { /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ interface PictureContentControlData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. @@ -163626,25 +163975,25 @@ declare namespace Word { /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ interface GroupContentControlData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. @@ -163720,25 +164069,25 @@ declare namespace Word { /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ interface BuildingBlockGalleryContentControlData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. @@ -163828,26 +164177,26 @@ declare namespace Word { /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ interface RepeatingSectionContentControlData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * 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 - */ + * 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; /** * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. @@ -164169,25 +164518,25 @@ declare namespace Word { /** An interface describing the data returned by calling `frame.toJSON()`. */ interface FrameData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalData; /** * Specifies the height (in points) of the frame. @@ -164344,18 +164693,18 @@ declare namespace Word { /** An interface describing the data returned by calling `listFormat.toJSON()`. */ interface ListFormatData { /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ list?: Word.Interfaces.ListData; /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listTemplate?: Word.Interfaces.ListTemplateData; /** * Indicates whether the `ListFormat` object contains a single list. @@ -164403,18 +164752,18 @@ declare namespace Word { /** 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: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatData; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatData; /** * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. @@ -164563,11 +164912,11 @@ declare namespace Word { /** 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: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ color?: Word.Interfaces.ColorFormatData; /** * Specifies the length of the radius for a glow effect. @@ -164587,18 +164936,18 @@ declare namespace Word { /** 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: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatData; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatData; /** * Specifies the length of the arrowhead at the beginning of the line. @@ -164771,11 +165120,11 @@ declare namespace Word { /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ interface ShadowFormatData { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatData; /** * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. @@ -164854,18 +165203,18 @@ declare namespace Word { /** 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: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ contourColor?: Word.Interfaces.ColorFormatData; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ extrusionColor?: Word.Interfaces.ColorFormatData; /** * Specifies the depth of the bottom bevel. @@ -165048,11 +165397,11 @@ declare namespace Word { /** An interface describing the data returned by calling `bibliography.toJSON()`. */ interface BibliographyData { /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ sources?: Word.Interfaces.SourceData[]; /** * Specifies the name of the active style to use for the bibliography. @@ -165093,18 +165442,18 @@ declare namespace Word { /** 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: WordApiDesktop 1.3] - */ + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lineNumbering?: Word.Interfaces.LineNumberingData; /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textColumns?: Word.Interfaces.TextColumnData[]; /** * Specifies whether Microsoft Word prints the document as a booklet. @@ -165525,12 +165874,12 @@ declare namespace Word { /** An interface describing the data returned by calling `bookmark.toJSON()`. */ interface BookmarkData { /** - * 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 - */ + * 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.RangeData; /** * Specifies the ending character position of the bookmark. @@ -165588,12 +165937,12 @@ declare namespace Word { /** An interface describing the data returned by calling `index.toJSON()`. */ interface IndexData { /** - * 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 - */ + * 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.RangeData; /** * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. @@ -165687,7 +166036,7 @@ declare namespace Word { items?: Word.Interfaces.ListTemplateGalleryData[]; } /** - * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -165699,20 +166048,20 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `Range` object that represents the next range that the editor has permissions to modify. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ nextRange?: Word.Interfaces.RangeLoadOptions; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. @@ -165744,12 +166093,12 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Gets the `RevisionType` for the `Conflict` object. @@ -165773,12 +166122,12 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the `RevisionType` for the `Conflict` object. @@ -165801,11 +166150,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the range of text that is annotated. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the range of text that is annotated. + * + * @remarks + * [Api set: WordApi 1.7] + */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the critique that was passed when the annotation was inserted. @@ -165827,14 +166176,14 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the critique annotation object. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the `CritiqueAnnotation` object. + * + * @remarks + * [Api set: WordApi 1.7] + */ critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. * * @remarks * [Api set: WordApi 1.7] @@ -165860,14 +166209,14 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the critique annotation object. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * For EACH ITEM in the collection: Gets the `CritiqueAnnotation` object. + * + * @remarks + * [Api set: WordApi 1.7] + */ critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. * * @remarks * [Api set: WordApi 1.7] @@ -165882,7 +166231,7 @@ declare namespace Word { state?: boolean; } /** - * Represents the application object. + * Represents the `Application` object. * * @remarks * [Api set: WordApi 1.3] @@ -165893,11 +166242,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyLoadOptions; /** * Specifies if Microsoft Word automatically detects the language you are using as you type. @@ -165926,53 +166275,53 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentSection?: Word.Interfaces.SectionLoadOptions; /** - * Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; /** * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. @@ -165996,7 +166345,7 @@ declare namespace Word { */ text?: 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. + * Gets the type of the body. The type can be `mainDoc`, `section`, `header`, `footer`, or `tableCell`. Additional types `footnote`, `endnote`, and `noteItem` are supported in WordApi 1.5 and later. * * @remarks * [Api set: WordApi 1.3] @@ -166004,7 +166353,7 @@ declare namespace Word { type?: boolean; } /** - * Represents the Border object for text, a paragraph, or a table. + * Represents the `Border` object for text, a paragraph, or a table. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -166234,7 +166583,7 @@ declare namespace Word { lineWidth?: boolean; } /** - * Represents a break in a Word document. + * Represents a break in a Word document. This could be a page, column, or section break. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -166245,11 +166594,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** * Returns the page number on which the break occurs. @@ -166271,11 +166620,11 @@ declare namespace Word { */ $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: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Returns the page number on which the break occurs. @@ -166297,18 +166646,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlockCategory` object that represents the category for the building block. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlockCategory` object that represents the category for the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; /** - * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** * Specifies the description for the building block. @@ -166365,11 +166714,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** * Returns the position of the `BuildingBlockCategory` object in a collection. @@ -166444,20 +166793,20 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the owner of the lock. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the owner of the lock. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ owner?: Word.Interfaces.CoauthorLoadOptions; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets a `CoauthoringLockType` value that represents the lock type. @@ -166481,20 +166830,20 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the owner of the lock. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the owner of the lock. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ owner?: Word.Interfaces.CoauthorLoadOptions; /** - * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Gets a `CoauthoringLockType` value that represents the lock type. @@ -166608,12 +166957,12 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `Coauthor` object that represents the current user. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Coauthor` object that represents the current user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ me?: Word.Interfaces.CoauthorLoadOptions; /** * Gets whether this document can be coauthored. @@ -166653,12 +167002,12 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; } /** @@ -166674,12 +167023,12 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; } /** @@ -166694,11 +167043,11 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** * Gets the email of the comment's author. @@ -166736,7 +167085,7 @@ declare namespace Word { */ 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 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] @@ -166755,11 +167104,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** * For EACH ITEM in the collection: Gets the email of the comment's author. @@ -166797,7 +167146,7 @@ declare namespace Word { */ id?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * For EACH ITEM in the collection: 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] @@ -166856,7 +167205,7 @@ declare namespace Word { */ text?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * 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] @@ -166875,18 +167224,18 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentComment?: Word.Interfaces.CommentLoadOptions; /** * Gets the email of the comment reply's author. @@ -166936,18 +167285,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentComment?: Word.Interfaces.CommentLoadOptions; /** * For EACH ITEM in the collection: Gets the email of the comment reply's author. @@ -166998,28 +167347,28 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `Font` object that represents the font formatting for the conditional style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `Font` object that represents the font formatting for the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ font?: Word.Interfaces.FontLoadOptions; /** - * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * Returns a `ShadingUniversal` object that represents the shading of the conditional style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ShadingUniversal` object that represents the shading of the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. @@ -167066,18 +167415,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. @@ -167218,12 +167567,12 @@ declare namespace Word { */ $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 - */ + * 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. @@ -167271,12 +167620,12 @@ declare namespace Word { */ $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 - */ + * 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. @@ -167323,46 +167672,46 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. @@ -167426,46 +167775,46 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** * Gets the base name of the node without the namespace prefix, if one exists. @@ -167529,119 +167878,119 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Gets the parent body of the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the content control. + * + * @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] - */ + * 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; /** - * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * 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] - */ + * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks * [Api set: WordApi 1.1] @@ -167676,28 +168025,28 @@ declare namespace Word { */ placeholderText?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ removeWhenEdited?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * 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?: 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 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?: boolean; /** - * 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. + * Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. * * @remarks * [Api set: WordApi 1.3] @@ -167725,7 +168074,7 @@ declare namespace Word { */ title?: boolean; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. * * @remarks * [Api set: WordApi 1.1] @@ -167744,119 +168093,119 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * For EACH ITEM in the collection: Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets 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] - */ + * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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.1] */ appearance?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks * [Api set: WordApi 1.1] @@ -167891,28 +168240,28 @@ declare namespace Word { */ placeholderText?: boolean; /** - * 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: Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ removeWhenEdited?: boolean; /** - * 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: 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?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * 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 1.3] */ styleBuiltIn?: 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: Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. * * @remarks * [Api set: WordApi 1.3] @@ -167940,7 +168289,7 @@ declare namespace Word { */ title?: 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 content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. * * @remarks * [Api set: WordApi 1.1] @@ -168091,11 +168440,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** * Gets a value that indicates whether the `CustomXmlPart` is built-in. @@ -168138,11 +168487,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. @@ -168185,11 +168534,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. @@ -168221,7 +168570,7 @@ declare namespace Word { 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. + * 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] @@ -168232,102 +168581,102 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the active window for the document. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ activeWindow?: Word.Interfaces.WindowLoadOptions; /** - * Specifies a `Template` object that represents the template attached to the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a `Template` object that represents the template attached to the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ attachedTemplate?: Word.Interfaces.TemplateLoadOptions; /** - * Gets a `Shape` object that represents the background image for the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Shape` object that represents the background image for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ background?: Word.Interfaces.ShapeLoadOptions; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Gets a `DocumentProperties` object that represents all the built-in document properties for the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `DocumentProperties` object that represents all the built-in document properties for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ builtInDocumentProperties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Gets a `Coauthoring` object for managing coauthoring in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Coauthoring` object for managing coauthoring in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ coauthoring?: Word.Interfaces.CoauthoringLoadOptions; /** - * Gets a `Range` object that represents the main document story. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the main document story. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ content?: Word.Interfaces.RangeLoadOptions; /** - * Gets a `DocumentProperties` collection that represents all the custom document properties for the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `DocumentProperties` collection that represents all the custom document properties for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ customDocumentProperties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Returns a `PageSetup` object that's associated with the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Returns a `Selection` object that represents the current selection in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `Selection` object that represents the current selection in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ selection?: Word.Interfaces.SelectionLoadOptions; /** - * Gets the `WebSettings` object for webpage-related attributes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the `WebSettings` object for webpage-related attributes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ webSettings?: Word.Interfaces.WebSettingsLoadOptions; /** * Gets the name of the active theme and formatting options. @@ -168996,7 +169345,7 @@ declare namespace Word { */ saveFormat?: 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. + * 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] @@ -169089,10 +169438,10 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlSaveThroughXSLT?: boolean; + xmlSaveThroughXslt?: boolean; } /** - * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. + * 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] @@ -169103,21 +169452,21 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ + * Gets the `Body` object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -169271,76 +169620,76 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `LinkFormat` object that represents the link options of the field. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `LinkFormat` object that represents the link options of the field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** - * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** - * Gets the parent body of the field. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the parent body of the field. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ result?: Word.Interfaces.RangeLoadOptions; /** * Specifies the field's code instruction. @@ -169352,7 +169701,7 @@ declare namespace Word { */ code?: 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 data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks * [Api set: WordApi 1.5] @@ -169403,76 +169752,76 @@ declare namespace Word { */ $all?: boolean; /** - * 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 - */ + * 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 + */ linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * 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 + */ oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the field. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the parent body of the field. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ result?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies the field's code instruction. @@ -169484,7 +169833,7 @@ declare namespace Word { */ code?: 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 data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks * [Api set: WordApi 1.5] @@ -169531,53 +169880,53 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ fill?: Word.Interfaces.FillFormatLoadOptions; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ glow?: Word.Interfaces.GlowFormatLoadOptions; /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ line?: Word.Interfaces.LineFormatLoadOptions; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ reflection?: Word.Interfaces.ReflectionFormatLoadOptions; /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textShadow?: Word.Interfaces.ShadowFormatLoadOptions; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatLoadOptions; /** * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: @@ -169593,7 +169942,7 @@ declare namespace Word { */ allCaps?: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -169613,7 +169962,7 @@ declare namespace Word { */ boldBidirectional?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApi 1.1] @@ -169655,7 +170004,7 @@ declare namespace Word { */ 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. + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -169695,21 +170044,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hidden?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * 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?: boolean; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -169743,7 +170092,7 @@ declare namespace Word { */ ligature?: boolean; /** - * Specifies a value that represents the name of the font. + * Specifies the name of the font. * * @remarks * [Api set: WordApi 1.1] @@ -169832,7 +170181,7 @@ declare namespace Word { */ shadow?: boolean; /** - * Specifies a value that represents the font size in points. + * Specifies the font size in points. * * @remarks * [Api set: WordApi 1.1] @@ -169866,7 +170215,7 @@ declare namespace Word { */ spacing?: boolean; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -169880,21 +170229,21 @@ declare namespace Word { */ stylisticSet?: boolean; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ subscript?: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ superscript?: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies the font's underline type. `none` if the font isn't underlined. * * @remarks * [Api set: WordApi 1.1] @@ -169978,11 +170327,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies the address (for example, a file name or URL) of the hyperlink. @@ -170060,11 +170409,11 @@ declare namespace Word { */ $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: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. @@ -170142,53 +170491,53 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the parent paragraph that contains the inline image. - * - * @remarks - * [Api set: WordApi 1.2] - */ + * 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] - */ + * 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] - */ + * 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] - */ + * 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] - */ + * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * Specifies a string that represents the alternative text associated with the inline image. @@ -170252,53 +170601,53 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. - * - * @remarks - * [Api set: WordApi 1.2] - */ + * 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] - */ + * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. @@ -170431,21 +170780,21 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the list's id. + * Gets the list's ID. * * @remarks * [Api set: WordApi 1.3] */ id?: 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. + * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks * [Api set: WordApi 1.3] */ levelExistences?: boolean; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. * * @remarks * [Api set: WordApi 1.3] @@ -170464,21 +170813,21 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the list's id. + * For EACH ITEM in the collection: Gets the list's ID. * * @remarks * [Api set: WordApi 1.3] */ id?: 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. + * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks * [Api set: WordApi 1.3] */ levelExistences?: boolean; /** - * For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * 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.3] @@ -170530,77 +170879,77 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApiDesktop 1.1] */ alignment?: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ linkedStyle?: boolean; /** - * Specifies the number format for the specified list level. + * Specifies the number format for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberFormat?: boolean; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberPosition?: boolean; /** - * Specifies the number style for the list level object. + * Specifies the number style for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberStyle?: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the list level that must appear before it restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ resetOnHigher?: boolean; /** - * Specifies the starting number for the specified list level object. + * Specifies the starting number for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ startAt?: boolean; /** - * Specifies the tab position for the specified list level object. + * Specifies the tab position for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ tabPosition?: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ textPosition?: boolean; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the character inserted after the number for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -170619,77 +170968,77 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * For EACH ITEM in the collection: Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * 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: Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApiDesktop 1.1] */ alignment?: boolean; /** - * 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: Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ linkedStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies the number format for the specified list level. + * For EACH ITEM in the collection: Specifies the number format for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberFormat?: 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 the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberPosition?: boolean; /** - * For EACH ITEM in the collection: Specifies the number style for the list level object. + * For EACH ITEM in the collection: Specifies the number style for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberStyle?: 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 list level that must appear before it restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ resetOnHigher?: 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 starting number for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ startAt?: 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 tab position for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ tabPosition?: 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 position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ textPosition?: 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: Specifies the character inserted after the number for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -170735,18 +171084,18 @@ declare namespace Word { */ $all?: boolean; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ reference?: Word.Interfaces.RangeLoadOptions; /** * Represents the note item type: footnote or endnote. @@ -170768,18 +171117,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ reference?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. @@ -170908,7 +171257,7 @@ declare namespace Word { width?: boolean; } /** - * Represents the collection of page. + * Represents the collection of {@link Word.Page} objects. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -170952,16 +171301,16 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `Selection` object that represents the current selection in the pane. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `Selection` object that represents the current selection in the pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ selection?: Word.Interfaces.SelectionLoadOptions; } /** - * Represents the collection of pane. + * Represents the collection of {@link Word.Pane} objects. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -170972,12 +171321,12 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns a `Selection` object that represents the current selection in the pane. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Returns a `Selection` object that represents the current selection in the pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ selection?: Word.Interfaces.SelectionLoadOptions; } /** @@ -170992,35 +171341,35 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the active pane in the window. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the active pane in the window. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ activePane?: Word.Interfaces.PaneLoadOptions; /** - * Gets the next document window in the collection of open document windows. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the next document window in the collection of open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ next?: Word.Interfaces.WindowLoadOptions; /** - * Gets the previous document window in the collection open document windows. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the previous document window in the collection open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ previous?: Word.Interfaces.WindowLoadOptions; /** - * Gets the `View` object that represents the view for the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the `View` object that represents the view for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ view?: Word.Interfaces.ViewLoadOptions; /** * Specifies whether rulers are displayed for the window or pane. @@ -171103,7 +171452,7 @@ declare namespace Word { */ isDocumentMapVisible?: boolean; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Specifies whether the email message header is visible in the document window. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -171264,7 +171613,7 @@ declare namespace Word { windowState?: boolean; } /** - * Represents the collection of window objects. + * Represents the collection of {@link Word.Window} objects. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -171275,35 +171624,35 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the active pane in the window. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the active pane in the window. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ activePane?: Word.Interfaces.PaneLoadOptions; /** - * For EACH ITEM in the collection: Gets the next document window in the collection of open document windows. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the next document window in the collection of open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ next?: Word.Interfaces.WindowLoadOptions; /** - * For EACH ITEM in the collection: Gets the previous document window in the collection open document windows. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the previous document window in the collection open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ previous?: Word.Interfaces.WindowLoadOptions; /** - * For EACH ITEM in the collection: Gets the `View` object that represents the view for the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the `View` object that represents the view for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ view?: Word.Interfaces.ViewLoadOptions; /** * For EACH ITEM in the collection: Specifies whether rulers are displayed for the window or pane. @@ -171386,7 +171735,7 @@ declare namespace Word { */ isDocumentMapVisible?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the email message header is visible in the document window. The default value is `False`. + * 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)] @@ -171558,98 +171907,98 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ list?: Word.Interfaces.ListLoadOptions; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItem?: Word.Interfaces.ListItemLoadOptions; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * Gets the parent body of the paragraph. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the paragraph. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.1] @@ -171780,98 +172129,98 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ list?: Word.Interfaces.ListLoadOptions; /** - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItem?: Word.Interfaces.ListItemLoadOptions; /** - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the paragraph. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the paragraph. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.1] @@ -172112,74 +172461,74 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * Gets the parent body of the range. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Specifies whether the range is formatted as bold. @@ -172464,74 +172813,74 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the range. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. @@ -172817,49 +173166,49 @@ declare namespace Word { */ $all?: boolean; /** - * 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. + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignorePunct?: boolean; /** - * 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. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignoreSpace?: boolean; /** - * 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. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchCase?: boolean; /** - * 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. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchPrefix?: boolean; /** - * 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. + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchSuffix?: boolean; /** - * 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. + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchWholeWord?: boolean; /** - * 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. + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] @@ -172878,18 +173227,18 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** * Specifies if the section is protected for forms. @@ -172911,18 +173260,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** * For EACH ITEM in the collection: Specifies if the section is protected for forms. @@ -172996,60 +173345,60 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * For EACH ITEM in the collection: Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderCollectionLoadOptions; /** - * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frame?: Word.Interfaces.FrameLoadOptions; /** - * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * For EACH ITEM in the collection: Gets a `ListTemplate` object that represents the list formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * For EACH ITEM in the collection: Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingLoadOptions; /** - * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * For EACH ITEM in the collection: Gets a `TableStyle` object representing style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** * For EACH ITEM in the collection: Specifies whether the style is automatically redefined based on the selection. @@ -173068,14 +173417,14 @@ declare namespace Word { */ baseStyle?: boolean; /** - * For EACH ITEM in the collection: Gets whether the specified style is a built-in style. + * For EACH ITEM in the collection: Gets whether the style is a built-in style. * * @remarks * [Api set: WordApi 1.5] */ builtIn?: boolean; /** - * For EACH ITEM in the collection: Gets the description of the specified style. + * For EACH ITEM in the collection: Gets the description of the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -173090,7 +173439,7 @@ declare namespace Word { */ hasProofing?: boolean; /** - * For EACH ITEM in the collection: 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. + * For EACH ITEM in the collection: Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks * [Api set: WordApi 1.5] @@ -173111,7 +173460,7 @@ declare namespace Word { */ languageIdFarEast?: boolean; /** - * For EACH ITEM in the collection: Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * For EACH ITEM in the collection: Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks * [Api set: WordApi 1.5] @@ -173132,14 +173481,14 @@ declare namespace Word { */ locked?: boolean; /** - * For EACH ITEM in the collection: Gets the name of a style in the language of the user. + * For EACH ITEM in the collection: Gets the name of the style in the language of the user. * * @remarks * [Api set: WordApi 1.5] */ nameLocal?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks * [Api set: WordApi 1.5] @@ -173176,14 +173525,14 @@ declare namespace Word { */ type?: boolean; /** - * For EACH ITEM in the collection: 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. + * For EACH ITEM in the collection: Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks * [Api set: WordApi 1.5] */ unhideWhenUsed?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * For EACH ITEM in the collection: Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] @@ -173202,60 +173551,60 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderCollectionLoadOptions; /** - * Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Returns a `Frame` object that represents the frame formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frame?: Word.Interfaces.FrameLoadOptions; /** - * Specifies a link between a paragraph and a character style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `ListTemplate` object that represents the list formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingLoadOptions; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a `TableStyle` object representing style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** * Specifies whether the style is automatically redefined based on the selection. @@ -173274,14 +173623,14 @@ declare namespace Word { */ baseStyle?: boolean; /** - * Gets whether the specified style is a built-in style. + * Gets whether the style is a built-in style. * * @remarks * [Api set: WordApi 1.5] */ builtIn?: boolean; /** - * Gets the description of the specified style. + * Gets the description of the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -173296,7 +173645,7 @@ declare namespace Word { */ hasProofing?: boolean; /** - * 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. + * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks * [Api set: WordApi 1.5] @@ -173317,7 +173666,7 @@ declare namespace Word { */ languageIdFarEast?: boolean; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks * [Api set: WordApi 1.5] @@ -173338,14 +173687,14 @@ declare namespace Word { */ locked?: boolean; /** - * Gets the name of a style in the language of the user. + * Gets the name of the style in the language of the user. * * @remarks * [Api set: WordApi 1.5] */ nameLocal?: 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 name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks * [Api set: WordApi 1.5] @@ -173382,14 +173731,14 @@ declare namespace Word { */ type?: 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. + * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks * [Api set: WordApi 1.5] */ unhideWhenUsed?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] @@ -173397,7 +173746,7 @@ declare namespace Word { visibility?: boolean; } /** - * Represents the shading object. + * Represents the `Shading` object. * * @remarks * [Api set: WordApi 1.6] @@ -173488,71 +173837,71 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Returns the `ShadingUniversal` object that represents the shading of the table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the `ShadingUniversal` object that represents the shading of the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApi 1.3] @@ -173574,7 +173923,7 @@ declare namespace Word { */ headerRowCount?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] @@ -173673,7 +174022,7 @@ declare namespace Word { */ values?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -173688,7 +174037,7 @@ declare namespace Word { width?: boolean; } /** - * Represents the TableStyle object. + * Represents the `TableStyle` object. * * @remarks * [Api set: WordApi 1.6] @@ -173699,12 +174048,12 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ shading?: Word.Interfaces.ShadingLoadOptions; /** * Specifies the table's alignment against the page margin. @@ -173714,7 +174063,7 @@ declare namespace Word { */ alignment?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -173809,20 +174158,20 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the next tab stop in the collection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * 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 - */ + * 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. @@ -173870,20 +174219,20 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the next tab stop in the collection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * 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 - */ + * 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. @@ -173919,7 +174268,7 @@ declare namespace Word { position?: boolean; } /** - * Contains the collection of the document's Table objects. + * Contains the collection of the document's {@link Word.Table} objects. * * @remarks * [Api set: WordApi 1.3] @@ -173930,71 +174279,71 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApi 1.3] @@ -174016,7 +174365,7 @@ declare namespace Word { */ headerRowCount?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -174115,7 +174464,7 @@ declare namespace Word { */ values?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -174141,11 +174490,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Returns the position of this column in a collection. @@ -174210,11 +174559,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Returns the position of this column in a collection. @@ -174280,12 +174629,12 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the portion of a document that is this table of authorities. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the portion of a document that is this table of authorities. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies the name of the bookmark from which to collect table of authorities entries. @@ -174390,12 +174739,12 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the portion of a document that is this table of authorities. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the portion of a document that is this table of authorities. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies the name of the bookmark from which to collect table of authorities entries. @@ -174645,12 +174994,12 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the portion of a document that is this table of contents. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the portion of a document that is this table of contents. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of contents. @@ -174746,12 +175095,12 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the portion of a document that is this table of figures. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the portion of a document that is this table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies whether built-in heading styles are used for the table of figures. @@ -174863,12 +175212,12 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the portion of a document that is this table of figures. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the portion of a document that is this table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of figures. @@ -174979,34 +175328,34 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets parent table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Returns the `Range` object that represents the table row. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the `Range` object that represents the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the `ShadingUniversal` object that represents the shading of the table row. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the `ShadingUniversal` object that represents the shading of the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Gets the number of cells in the row. @@ -175016,14 +175365,14 @@ declare namespace Word { */ cellCount?: boolean; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] */ horizontalAlignment?: boolean; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks * [Api set: WordApi 1.3] @@ -175058,7 +175407,7 @@ declare namespace Word { */ values?: boolean; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -175066,7 +175415,7 @@ declare namespace Word { verticalAlignment?: boolean; } /** - * Contains the collection of the document's TableRow objects. + * Contains the collection of the document's {@link Word.TableRow} objects. * * @remarks * [Api set: WordApi 1.3] @@ -175077,34 +175426,34 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets parent table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Returns the `Range` object that represents the table row. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Returns the `Range` object that represents the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table row. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Gets the number of cells in the row. @@ -175114,14 +175463,14 @@ declare namespace Word { */ cellCount?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] */ horizontalAlignment?: boolean; /** - * For EACH ITEM in the collection: Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * For EACH ITEM in the collection: Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks * [Api set: WordApi 1.3] @@ -175156,7 +175505,7 @@ declare namespace Word { */ values?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * For EACH ITEM in the collection: Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -175175,41 +175524,41 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Returns the `TableColumn` object that represents the table column that contains this cell. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the `TableColumn` object that represents the table column that contains this cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ column?: Word.Interfaces.TableColumnLoadOptions; /** - * Gets the parent row of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent row of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentRow?: Word.Interfaces.TableRowLoadOptions; /** - * Gets the parent table of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent table of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Returns the `ShadingUniversal` object that represents the shading of the table cell. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the `ShadingUniversal` object that represents the shading of the table cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Gets the index of the cell in its row. @@ -175226,7 +175575,7 @@ declare namespace Word { */ columnWidth?: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -175254,7 +175603,7 @@ declare namespace Word { */ value?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -175269,7 +175618,7 @@ declare namespace Word { width?: boolean; } /** - * Contains the collection of the document's TableCell objects. + * Contains the collection of the document's {@link Word.TableCell} objects. * * @remarks * [Api set: WordApi 1.3] @@ -175280,41 +175629,41 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Returns the `TableColumn` object that represents the table column that contains this cell. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Returns the `TableColumn` object that represents the table column that contains this cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ column?: Word.Interfaces.TableColumnLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent row of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent row of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentRow?: Word.Interfaces.TableRowLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent table of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent table of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table cell. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Gets the index of the cell in its row. @@ -175331,7 +175680,7 @@ declare namespace Word { */ columnWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * For EACH ITEM in the collection: Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -175359,7 +175708,7 @@ declare namespace Word { */ value?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * For EACH ITEM in the collection: Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -175721,12 +176070,12 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the instance of a `RevisionsFilter` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * 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. @@ -176149,60 +176498,60 @@ declare namespace Word { */ $all?: boolean; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ canvas?: Word.Interfaces.CanvasLoadOptions; /** - * Returns the fill formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the fill formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ fill?: Word.Interfaces.ShapeFillLoadOptions; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentCanvas?: Word.Interfaces.ShapeLoadOptions; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentGroup?: Word.Interfaces.ShapeLoadOptions; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; /** - * Gets the text frame object of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `TextFrame` object of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textFrame?: Word.Interfaces.TextFrameLoadOptions; /** - * Returns the text wrap formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; /** * Specifies whether a given shape can overlap other shapes. @@ -176360,7 +176709,7 @@ declare namespace Word { widthRelative?: boolean; } /** - * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. + * Represents a shape group in the document. To get the corresponding {@link Word.Shape} object, use `ShapeGroup.shape`. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -176371,11 +176720,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the Shape object associated with the group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeLoadOptions; /** * Gets an integer that represents the shape group identifier. @@ -176386,7 +176735,7 @@ declare namespace Word { id?: boolean; } /** - * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * Represents a canvas in the document. To get the corresponding {@link Word.Shape} object, use `Canvas.shape`. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -176397,11 +176746,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the Shape object associated with the canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeLoadOptions; /** * Gets an integer that represents the canvas identifier. @@ -176423,60 +176772,60 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ canvas?: Word.Interfaces.CanvasLoadOptions; /** - * For EACH ITEM in the collection: Returns the fill formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Returns the fill formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ fill?: Word.Interfaces.ShapeFillLoadOptions; /** - * For EACH ITEM in the collection: Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentCanvas?: Word.Interfaces.ShapeLoadOptions; /** - * For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentGroup?: Word.Interfaces.ShapeLoadOptions; /** - * For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; /** - * For EACH ITEM in the collection: Gets the text frame object of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the `TextFrame` object of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textFrame?: Word.Interfaces.TextFrameLoadOptions; /** - * For EACH ITEM in the collection: Returns the text wrap formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; /** * For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes. @@ -176634,7 +176983,7 @@ declare namespace Word { widthRelative?: boolean; } /** - * Represents the fill formatting of a shape object. + * Represents the fill formatting of a {@link Word.Shape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -176674,7 +177023,7 @@ declare namespace Word { type?: boolean; } /** - * Represents the text frame of a shape object. + * Represents the text frame of a {@link Word.Shape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -176685,63 +177034,63 @@ declare namespace Word { */ $all?: 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. + * Specifies the automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks * [Api set: WordApiDesktop 1.2] */ autoSizeSetting?: boolean; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the bottom margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ bottomMargin?: boolean; /** - * Specifies if the text frame contains text. + * Returns `true` if the text frame contains text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hasText?: boolean; /** - * Represents the left margin, in points, of the text frame. + * Specifies the left margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ leftMargin?: boolean; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. * * @remarks * [Api set: WordApiDesktop 1.2] */ noTextRotation?: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks * [Api set: WordApiDesktop 1.2] */ orientation?: boolean; /** - * Represents the right margin, in points, of the text frame. + * Specifies the right margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ rightMargin?: boolean; /** - * Represents the top margin, in points, of the text frame. + * Specifies the top margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ topMargin?: boolean; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -176756,7 +177105,7 @@ declare namespace Word { wordWrap?: boolean; } /** - * Represents all the properties for wrapping text around a shape. + * Represents all the properties for wrapping text around a {@link Word.Shape}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -176892,11 +177241,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns the range of this repeating section item, excluding the start and end tags. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; } /** @@ -176912,20 +177261,20 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ movedRange?: Word.Interfaces.RangeLoadOptions; /** - * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the name of the user who made the tracked change. @@ -176969,7 +177318,7 @@ declare namespace Word { type?: boolean; } /** - * A collection of Revision objects that represent the changes marked with revision marks in a range or document. + * A collection of {@link Word.Revision} objects that represent the changes marked with revision marks in a range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -176981,20 +177330,20 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ movedRange?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained within a revision mark. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Gets the name of the user who made the tracked change. @@ -177049,25 +177398,25 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** * Specifies the appearance of the content control. @@ -177180,25 +177529,25 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** * Specifies the appearance of the content control. @@ -177283,25 +177632,25 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** * Specifies the appearance of the content control. @@ -177386,25 +177735,25 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** * Specifies the appearance of the content control. @@ -177503,26 +177852,26 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * 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 - */ + * 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.XmlMappingLoadOptions; /** * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. @@ -177773,60 +178122,60 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ firstChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ lastChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ nextSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent document of this XML node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the parent document of this XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ ownerDocument?: Word.Interfaces.DocumentLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent element of this XML node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the parent element of this XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ parentNode?: Word.Interfaces.XmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ previousSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Gets the name of the element without any prefix. @@ -177922,60 +178271,60 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ firstChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ lastChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ nextSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the parent document of this XML node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the parent document of this XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ ownerDocument?: Word.Interfaces.DocumentLoadOptions; /** - * Gets the parent element of this XML node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the parent element of this XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ parentNode?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ previousSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the name of the element without any prefix. @@ -178069,12 +178418,12 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `Range` object that represents the portion of a document that's contained in this HTML division. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets a `Range` object that represents the portion of a document that's contained in this HTML division. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies the left indent value (in points) for this HTML division. @@ -178122,12 +178471,12 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of a document that's contained in this HTML division. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of a document that's contained in this HTML division. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies the left indent value (in points) for this HTML division. @@ -178174,18 +178523,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Specifies the height (in points) of the frame. @@ -178284,18 +178633,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Specifies the height (in points) of the frame. @@ -178505,18 +178854,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ list?: Word.Interfaces.ListLoadOptions; /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** * Indicates whether the `ListFormat` object contains a single list. @@ -178573,18 +178922,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. @@ -178742,11 +179091,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ color?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the length of the radius for a glow effect. @@ -178776,18 +179125,18 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the length of the arrowhead at the beginning of the line. @@ -178987,11 +179336,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. @@ -179079,18 +179428,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ contourColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ extrusionColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the depth of the bottom bevel. @@ -179367,11 +179716,11 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lineNumbering?: Word.Interfaces.LineNumberingLoadOptions; /** * Specifies whether Microsoft Word prints the document as a booklet. @@ -179671,11 +180020,11 @@ declare namespace Word { } /** * Represents a selected range or the insertion point in a Word document. - - - Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] + * + * Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. * @beta */ interface SelectionLoadOptions { @@ -179684,36 +180033,36 @@ declare namespace Word { */ $all?: boolean; /** - * Returns the `Font` object that represents the character formatting of the selection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the `Font` object that represents the character formatting of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ font?: Word.Interfaces.FontLoadOptions; /** - * Specifies a `Range` object that includes the formatted text in the range or selection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Specifies a `Range` object that includes the formatted text in the range or selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ formattedText?: Word.Interfaces.RangeLoadOptions; /** - * Returns the `Range` object for the portion of the document contained in the selection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the `Range` object for the portion of the document contained in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the `ShadingUniversal` object for the shading formatting for the selection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns the `ShadingUniversal` object for the shading formatting for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Specifies the ending character position of the selection. @@ -179870,7 +180219,7 @@ declare namespace Word { type?: boolean; } /** - * Represents a collection of {@link Word.Range} objects that represents each character, word or sentence. + * Represents a collection of {@link Word.Range} objects that represents each character, word, or sentence. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -179882,74 +180231,74 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - */ + * 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)] + */ listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the range. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - */ + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. @@ -180236,12 +180585,12 @@ declare namespace Word { */ $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 - */ + * 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. @@ -180305,12 +180654,12 @@ declare namespace Word { */ $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 - */ + * 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. @@ -180375,12 +180724,12 @@ declare namespace Word { */ $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 - */ + * 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. @@ -180471,12 +180820,12 @@ declare namespace Word { */ $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 - */ + * 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. @@ -199809,12 +200158,12 @@ declare namespace PowerPoint { /** Gets the loaded child items in this collection. */ readonly items: PowerPoint.Slide[]; /** - * Adds a new slide at the end of the collection. + * Adds a new slide to the collection. * * @remarks * [Api set: PowerPointApi 1.3] * - * @param options The options that define the theme of the new slide. + * @param options Optional. Options for configuring the properties of the new slide. */ add(options?: PowerPoint.AddSlideOptions): void; /** diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 2d85a55d2585b3..4312260ba402cb 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -91373,28 +91373,28 @@ declare namespace Word { */ interface CritiquePopupOptions { /** - * Gets the manifest resource ID of the string to use for branding. This branding text appears next to your add-in icon in the pop-up menu. + * Specifies the manifest resource ID of the string to use for branding. This branding text appears next to your add-in icon in the pop-up menu. * * @remarks * [Api set: WordApi 1.8] */ brandingTextResourceId: string; /** - * Gets the manifest resource ID of the string to use as the subtitle. + * Specifies the manifest resource ID of the string to use as the subtitle. * * @remarks * [Api set: WordApi 1.8] */ subtitleResourceId: string; /** - * Gets the suggestions to display in the critique pop-up menu. + * Specifies the suggestions to display in the critique pop-up menu. * * @remarks * [Api set: WordApi 1.8] */ suggestions: string[]; /** - * Gets the manifest resource ID of the string to use as the title. + * Specifies the manifest resource ID of the string to use as the title. * * @remarks * [Api set: WordApi 1.8] @@ -91504,9 +91504,9 @@ declare namespace Word { */ untrack(): Word.CritiqueAnnotation; /** - * 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.CritiqueAnnotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CritiqueAnnotationData`) 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.CritiqueAnnotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CritiqueAnnotationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CritiqueAnnotationData; } /** @@ -91560,14 +91560,14 @@ declare namespace Word { /** 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 critique annotation object. + * Gets the `CritiqueAnnotation` object. * * @remarks * [Api set: WordApi 1.7] */ readonly critiqueAnnotation: Word.CritiqueAnnotation; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. * * @remarks * [Api set: WordApi 1.7] @@ -91617,9 +91617,9 @@ declare namespace Word { */ untrack(): Word.Annotation; /** - * 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.Annotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationData`) 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.Annotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.AnnotationData; } /** @@ -91765,13 +91765,13 @@ declare namespace Word { */ untrack(): Word.AnnotationCollection; /** - * 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.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.AnnotationCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.AnnotationCollectionData; } /** - * Represents the application object. + * Represents the `Application` object. * * @remarks * [Api set: WordApi 1.3] @@ -91821,7 +91821,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param base64File Optional. The Base64-encoded .docx file. The default value is null. + * @param base64File Optional. The Base64-encoded .docx file. The default value is `null`. */ createDocument(base64File?: string): Word.DocumentCreated; /** @@ -91837,7 +91837,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] * - * @param filePath Required. The absolute path of the .docx file. Word on the web only supports remote (cloud) locations, while Word on Windows, on Mac, and on iOS support local and remote locations. + * @param filePath The absolute path of the .docx file. Word on the web only supports remote (cloud) locations, while Word on Windows, on Mac, and on iOS support local and remote locations. */ openDocument(filePath: string): void; /** @@ -91846,7 +91846,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param base64File Required. The template file. + * @param base64File The template file. */ retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult; /** @@ -91875,9 +91875,9 @@ declare namespace Word { */ static newObject(context: OfficeExtension.ClientRequestContext): Word.Application; /** - * 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.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ApplicationData`) 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.Application` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ApplicationData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ApplicationData; } /** @@ -91904,7 +91904,7 @@ declare namespace Word { */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the body. + * Gets the collection of `Field` objects in the body. * * @remarks * [Api set: WordApi 1.4] @@ -91925,21 +91925,21 @@ declare namespace Word { */ readonly footnotes: Word.NoteItemCollection; /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. + * Gets the collection of `InlinePicture` objects in the body. The collection doesn't include floating images. * * @remarks * [Api set: WordApi 1.1] */ readonly inlinePictures: Word.InlinePictureCollection; /** - * Gets the collection of list objects in the body. + * Gets the collection of `List` objects in the body. * * @remarks * [Api set: WordApi 1.3] */ readonly lists: Word.ListCollection; /** - * Gets the collection of paragraph objects in the body. + * Gets the collection of `Paragraph` objects in the body. * * @remarks * [Api set: WordApi 1.1] @@ -91990,14 +91990,16 @@ declare namespace Word { */ readonly parentSectionOrNullObject: Word.Section; /** - * 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. + * Gets the collection of `Shape` objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. */ readonly shapes: Word.ShapeCollection; /** - * Gets the collection of table objects in the body. + * Gets the collection of `Table` objects in the body. * * @remarks * [Api set: WordApi 1.3] @@ -92018,14 +92020,14 @@ declare namespace Word { */ styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Gets the text of the body. Use the insertText method to insert text. + * Gets the text of the body. Use the `insertText` method to insert text. * * @remarks * [Api set: WordApi 1.1] */ readonly text: string; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * Gets the type of the body. The type can be `mainDoc`, `section`, `header`, `footer`, or `tableCell`. Additional types `footnote`, `endnote`, and `noteItem` are supported in WordApi 1.5 and later. * * @remarks * [Api set: WordApi 1.3] @@ -92040,7 +92042,7 @@ declare namespace Word { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Word.Body): void; /** - * Clears the contents of the body object. The user can perform the undo operation on the cleared content. + * Clears the contents of the `Body` object. The user can perform the undo operation on the cleared content. * * @remarks * [Api set: WordApi 1.1] @@ -92067,14 +92069,14 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the `Body` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. * * @remarks * [Api set: WordApi 1.1] */ getHtml(): OfficeExtension.ClientResult; /** - * Gets the OOXML (Office Open XML) representation of the body object. + * Gets the OOXML (Office Open XML) representation of the `Body` object. * * @remarks * [Api set: WordApi 1.1] @@ -92086,7 +92088,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `after`, or `content`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; /** @@ -92095,7 +92097,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** @@ -92104,11 +92106,11 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Gets the collection of the TrackedChange objects in the body. + * Gets the collection of the `TrackedChange` objects in the body. * * @remarks * [Api set: WordApi 1.6] @@ -92120,22 +92122,22 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param breakType Required. The break type to add to the body. - * @param insertLocation Required. The value must be 'Start' or 'End'. + * @param breakType The break type to add to the body. + * @param insertLocation The value must be `start` or `end`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): void; /** - * Wraps the Body object with a content control. + * Wraps the `Body` object with a content control. * * @remarks * [Api set: WordApi 1.1] * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. - * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. + * `dropDownList` and `comboBox` support was added in WordApi 1.9. Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. * - * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + * @param contentControlType Optional. Content control type to insert. Must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. The default is `richText`. */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl; /** * Inserts a document into the body at the specified location. * @@ -92144,8 +92146,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -92154,8 +92156,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param html Required. The HTML to be inserted in the document. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param html The HTML to be inserted in the document. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -92164,8 +92166,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted in the body. - * @param insertLocation Required. The value must be 'Start' or 'End'. + * @param base64EncodedImage The Base64-encoded image to be inserted in the body. + * @param insertLocation The value must be `start` or `end`. */ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.InlinePicture; /** @@ -92174,8 +92176,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param ooxml Required. The OOXML to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param ooxml The OOXML to be inserted. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -92184,8 +92186,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Start' or 'End'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `start` or `end`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.Paragraph; /** @@ -92194,9 +92196,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Start' or 'End'. + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `start` or `end`. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", values?: string[][]): Word.Table; @@ -92206,17 +92208,17 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param text Text to be inserted. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** - * Performs a search with the specified SearchOptions on the scope of the body object. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the `Body` object. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.1] * - * @param searchText Required. The search text. Can be a maximum of 255 characters. + * @param searchText The search text. Can be a maximum of 255 characters. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -92234,7 +92236,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -92243,7 +92245,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -92276,13 +92278,13 @@ declare namespace Word { */ untrack(): Word.Body; /** - * 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.Body` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BodyData`) 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.Body` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BodyData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BodyData; } /** - * Represents the Border object for text, a paragraph, or a table. + * Represents the `Border` object for text, a paragraph, or a table. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -92363,9 +92365,9 @@ declare namespace Word { */ untrack(): Word.Border; /** - * 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.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderData`) 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.Border` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BorderData; } /** @@ -92471,9 +92473,9 @@ declare namespace Word { */ untrack(): Word.BorderUniversal; /** - * 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.BorderUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderUniversalData`) 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.BorderUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderUniversalData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BorderUniversalData; } /** @@ -92488,7 +92490,7 @@ declare namespace Word { /** Gets the loaded child items in this collection. */ readonly items: Word.Border[]; /** - * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * 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] @@ -92509,7 +92511,7 @@ declare namespace Word { */ 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. + * 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] @@ -92551,12 +92553,12 @@ declare namespace Word { */ getFirstOrNullObject(): Word.Border; /** - * Gets a Border object by its index in the collection. + * Gets a `Border` object by its index in the collection. * * @remarks * [Api set: WordApiDesktop 1.1] * - * @param index A number that identifies the index location of a Border object. + * @param index The location of a `Border` object. */ getItem(index: number): Word.Border; /** @@ -92586,9 +92588,9 @@ declare namespace Word { */ untrack(): Word.BorderCollection; /** - * 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.BorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.BorderCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.BorderCollectionData; } /** @@ -92636,13 +92638,13 @@ declare namespace Word { */ untrack(): Word.BorderUniversalCollection; /** - * 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.BorderUniversalCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderUniversalCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.BorderUniversalCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BorderUniversalCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.BorderUniversalCollectionData; } /** - * Represents a break in a Word document. + * Represents a break in a Word document. This could be a page, column, or section break. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -92702,9 +92704,9 @@ declare namespace Word { */ untrack(): Word.Break; /** - * 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.Break` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BreakData`) 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.Break` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BreakData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BreakData; } /** @@ -92745,9 +92747,9 @@ declare namespace Word { */ untrack(): Word.BreakCollection; /** - * 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.BreakCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BreakCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.BreakCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BreakCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.BreakCollectionData; } /** @@ -92870,9 +92872,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlock; /** - * 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.BuildingBlock` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockData`) 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.BuildingBlock` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BuildingBlockData; } /** @@ -92948,9 +92950,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockCollection; /** - * 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.BuildingBlockCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCollectionData`) 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.BuildingBlockCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -93032,9 +93034,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockEntryCollection; /** - * 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.BuildingBlockEntryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockEntryCollectionData`) 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.BuildingBlockEntryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockEntryCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -93106,9 +93108,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockCategory; /** - * 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.BuildingBlockCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCategoryData`) 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.BuildingBlockCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCategoryData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BuildingBlockCategoryData; } /** @@ -93160,9 +93162,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockCategoryCollection; /** - * 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.BuildingBlockCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCategoryCollectionData`) 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.BuildingBlockCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockCategoryCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -93227,9 +93229,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockTypeItem; /** - * 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.BuildingBlockTypeItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockTypeItemData`) 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.BuildingBlockTypeItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockTypeItemData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BuildingBlockTypeItemData; } /** @@ -93290,9 +93292,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockTypeItemCollection; /** - * 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.BuildingBlockTypeItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockTypeItemCollectionData`) 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.BuildingBlockTypeItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockTypeItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): { [key: string]: string; }; @@ -93351,9 +93353,9 @@ declare namespace Word { */ untrack(): Word.CheckboxContentControl; /** - * 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.CheckboxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CheckboxContentControlData`) 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.CheckboxContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CheckboxContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CheckboxContentControlData; } /** @@ -93415,7 +93417,7 @@ declare namespace Word { */ readonly id: string; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * 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] @@ -93449,7 +93451,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param replyText Required. Reply text. + * @param replyText Reply text. */ reply(replyText: string): Word.CommentReply; /** @@ -93482,9 +93484,9 @@ declare namespace Word { */ untrack(): Word.Comment; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Comment` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Comment` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CommentData; } /** @@ -93539,12 +93541,14 @@ declare namespace Word { */ untrack(): Word.CommentCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CommentCollectionData; } /** + * Represents a content range within a comment. + * * @remarks * [Api set: WordApi 1.4] */ @@ -93552,7 +93556,7 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies whether the comment text is bold. * * @remarks * [Api set: WordApi 1.4] @@ -93573,14 +93577,14 @@ declare namespace Word { */ readonly isEmpty: boolean; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies 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. + * Specifies whether the comment text has a strikethrough. * * @remarks * [Api set: WordApi 1.4] @@ -93594,7 +93598,7 @@ declare namespace Word { */ readonly text: string; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Specifies the comment text's underline type. `none` if the comment text isn't underlined. * * @remarks * [Api set: WordApi 1.4] @@ -93614,8 +93618,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param text Required. The text to be inserted in to the CommentContentRange. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param text The text to be inserted in to the `CommentContentRange`. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange; /** @@ -93648,9 +93652,9 @@ declare namespace Word { */ untrack(): Word.CommentContentRange; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CommentContentRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CommentContentRange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentContentRangeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CommentContentRangeData; } /** @@ -93756,9 +93760,9 @@ declare namespace Word { */ untrack(): Word.CommentReply; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CommentReply` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CommentReply` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CommentReplyData; } /** @@ -93813,9 +93817,9 @@ declare namespace Word { */ untrack(): Word.CommentReplyCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CommentReplyCollectionData; } /** @@ -93926,9 +93930,9 @@ declare namespace Word { */ untrack(): Word.XmlMapping; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.XmlMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlMappingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.XmlMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlMappingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.XmlMappingData; } /** @@ -94026,9 +94030,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPrefixMappingCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlPrefixMappingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlPrefixMappingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlPrefixMappingCollectionData; } /** @@ -94084,9 +94088,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPrefixMapping; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlPrefixMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlPrefixMapping` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPrefixMappingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomXmlPrefixMappingData; } /** @@ -94156,9 +94160,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlSchema; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlSchema` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlSchema` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomXmlSchemaData; } /** @@ -94203,7 +94207,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param index A number that identifies the index location of a paragraph object. + * @param index The location of a `CustomXmlSchema` object. */ getItem(index: number): Word.CustomXmlSchema; /** @@ -94247,9 +94251,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlSchemaCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlSchemaCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlSchemaCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlSchemaCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlSchemaCollectionData; } /** @@ -94333,9 +94337,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlNodeCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlNodeCollectionData; } /** @@ -94718,9 +94722,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlNode; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.CustomXmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CustomXmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlNodeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomXmlNodeData; } /** @@ -94733,42 +94737,42 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly buildingBlockGalleryContentControl: Word.BuildingBlockGalleryContentControl; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.7] */ readonly checkboxContentControl: Word.CheckboxContentControl; /** - * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * Gets the data of the content control when its type is `comboBox`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.9] */ readonly comboBoxContentControl: Word.ComboBoxContentControl; /** - * Gets the collection of content control objects in the content control. + * Gets the collection of `ContentControl` objects in the content control. * * @remarks * [Api set: WordApi 1.1] */ readonly contentControls: Word.ContentControlCollection; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly datePickerContentControl: Word.DatePickerContentControl; /** - * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + * Gets the data of the content control when its type is `dropDownList`. It's `null` otherwise. * * @remarks * [Api set: WordApi 1.9] @@ -94782,7 +94786,7 @@ declare namespace Word { */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the content control. + * Gets the collection of `Field` objects in the content control. * * @remarks * [Api set: WordApi 1.4] @@ -94803,28 +94807,28 @@ declare namespace Word { */ readonly footnotes: Word.NoteItemCollection; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly groupContentControl: Word.GroupContentControl; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * Gets the collection of `InlinePicture` objects in the content control. The collection doesn't include floating images. * * @remarks * [Api set: WordApi 1.1] */ readonly inlinePictures: Word.InlinePictureCollection; /** - * Gets the collection of list objects in the content control. + * Gets the collection of `List` objects in the content control. * * @remarks * [Api set: WordApi 1.3] */ readonly lists: Word.ListCollection; /** - * Gets the collection of paragraph objects in the content control. + * Gets the collection of `Paragraph` objects in the content control. * * @remarks * [Api set: WordApi 1.1] @@ -94882,21 +94886,21 @@ declare namespace Word { */ readonly parentTableOrNullObject: Word.Table; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly pictureContentControl: Word.PictureContentControl; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. * * @remarks * [Api set: WordApiDesktop 1.3] */ readonly repeatingSectionContentControl: Word.RepeatingSectionContentControl; /** - * Gets the collection of table objects in the content control. + * Gets the collection of `Table` objects in the content control. * * @remarks * [Api set: WordApi 1.3] @@ -94910,14 +94914,14 @@ declare namespace Word { */ readonly xmlMapping: Word.XmlMapping; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks * [Api set: WordApi 1.1] @@ -94952,28 +94956,28 @@ declare namespace Word { */ placeholderText: string; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ removeWhenEdited: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * 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. + * 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. + * Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. * * @remarks * [Api set: WordApi 1.3] @@ -95001,7 +95005,7 @@ declare namespace Word { */ title: string; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. * * @remarks * [Api set: WordApi 1.1] @@ -95023,12 +95027,12 @@ declare namespace Word { */ clear(): void; /** - * Deletes the content control and its content. If `keepContent` is set to true, the content isn't deleted. + * Deletes the content control and its content. If `keepContent` is set to `true`, the content isn't deleted. * * @remarks * [Api set: WordApi 1.1] * - * @param keepContent Required. Indicates whether the content should be deleted with the content control. If `keepContent` is set to true, the content isn't deleted. + * @param keepContent Indicates whether the content should be deleted with the content control. If `keepContent` is set to `true`, the content isn't deleted. */ delete(keepContent: boolean): void; /** @@ -95052,14 +95056,14 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the `ContentControl` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. * * @remarks * [Api set: WordApi 1.1] */ getHtml(): OfficeExtension.ClientResult; /** - * Gets the Office Open XML (OOXML) representation of the content control object. + * Gets the Office Open XML (OOXML) representation of the `ContentControl` object. * * @remarks * [Api set: WordApi 1.1] @@ -95071,7 +95075,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'Before', 'After', or 'Content'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `before`, `after`, or `content`. */ getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range; /** @@ -95080,7 +95084,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** @@ -95089,34 +95093,34 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Gets the text ranges in the content control by using punctuation marks and/or other ending marks. + * Gets the text ranges in the content control by using punctuation marks and other ending marks. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Gets the collection of the TrackedChange objects in the content control. + * Gets the collection of the `TrackedChange` objects in the content control. * * @remarks * [Api set: WordApi 1.6] */ getTrackedChanges(): Word.TrackedChangeCollection; /** - * Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * Inserts a break at the specified location in the main document. This method cannot be used with `richTextTable`, `richTextTableRow`, and `richTextTableCell` content controls. * * @remarks * [Api set: WordApi 1.1] * - * @param breakType Required. Type of break. - * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. + * @param breakType Type of break. + * @param insertLocation The value must be `start`, `end`, `before`, or `after`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): void; /** @@ -95127,8 +95131,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. `replace` cannot be used with `richTextTable` and `richTextTableRow` content controls. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -95137,8 +95141,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param html Required. The HTML to be inserted in to the content control. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + * @param html The HTML to be inserted in to the content control. + * @param insertLocation The value must be `replace`, `start`, or `end`. `replace` cannot be used with `richTextTable` and `richTextTableRow` content controls. */ insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -95147,8 +95151,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted in the content control. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + * @param base64EncodedImage The Base64-encoded image to be inserted in the content control. + * @param insertLocation The value must be `replace`, `start`, or `end`. `replace` cannot be used with `richTextTable` and `richTextTableRow` content controls. */ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; /** @@ -95157,8 +95161,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param ooxml Required. The OOXML to be inserted in to the content control. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + * @param ooxml The OOXML to be inserted in to the content control. + * @param insertLocation The value must be `replace`, `start`, or `end`. `replace` cannot be used with `richTextTable` and `richTextTableRow` content controls. */ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -95167,8 +95171,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `start`, `end`, `before`, or `after`. `before` and `after` cannot be used with `richTextTable`, `richTextTableRow`, and `richTextTableCell` content controls. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; /** @@ -95177,9 +95181,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `start`, `end`, `before`, or `after`. `before` and `after` cannot be used with `richTextTable`, `richTextTableRow`, and `richTextTableCell` content controls. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After", values?: string[][]): Word.Table; @@ -95189,17 +95193,17 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param text Required. The text to be inserted in to the content control. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + * @param text The text to be inserted in to the content control. + * @param insertLocation The value must be `replace`, `start`, or `end`. `replace` cannot be used with `richTextTable` and `richTextTableRow` content controls. */ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** - * Performs a search with the specified SearchOptions on the scope of the content control object. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the `ContentControl` object. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.1] * - * @param searchText Required. The search text. + * @param searchText The search text. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -95217,7 +95221,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -95226,7 +95230,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -95235,10 +95239,10 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param delimiters Required. The delimiters as an array of strings. - * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters. - * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param delimiters The delimiters as an array of strings. + * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is `false` which indicates that the paragraph boundaries are also used as delimiters. + * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is `false` which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; /** @@ -95316,9 +95320,9 @@ declare namespace Word { */ untrack(): Word.ContentControl; /** - * 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.ContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlData`) 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.ContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ContentControlData; } /** @@ -95338,7 +95342,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param changeTrackingStates Required. An array of content control change tracking states. + * @param changeTrackingStates An array of content control change tracking states. */ getByChangeTrackingStates(changeTrackingStates: Word.ChangeTrackingState[]): Word.ContentControlCollection; /** @@ -95347,7 +95351,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param id Required. A content control identifier. + * @param id A content control identifier. */ getById(id: number): Word.ContentControl; /** @@ -95356,7 +95360,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param id Required. A content control identifier. + * @param id A content control identifier. */ getByIdOrNullObject(id: number): Word.ContentControl; /** @@ -95365,7 +95369,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param tag Required. A tag set on a content control. + * @param tag A tag set on a content control. */ getByTag(tag: string): Word.ContentControlCollection; /** @@ -95374,7 +95378,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param title Required. The title of a content control. + * @param title The title of a content control. */ getByTitle(title: string): Word.ContentControlCollection; /** @@ -95383,7 +95387,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param types Required. An array of content control types. + * @param types An array of content control types. */ getByTypes(types: Word.ContentControlType[]): Word.ContentControlCollection; /** @@ -95436,9 +95440,9 @@ declare namespace Word { */ untrack(): Word.ContentControlCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ContentControlCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.ContentControlCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ContentControlCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ContentControlCollectionData; } /** @@ -95595,13 +95599,13 @@ declare namespace Word { */ interface ContentControlOptions { /** - * An array of content control types, item must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. + * An array of content control types, item must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. * * @remarks * [Api set: WordApi 1.5] * - * Note: 'PlainText' support was added in WordApi 1.5. 'CheckBox' support was added in WordApi 1.7. - * 'DropDownList' and 'ComboBox' support was added in WordApi 1.9. + * Note: `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. `dropDownList` and `comboBox` support was added in WordApi 1.9. + * Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. */ types: Word.ContentControlType[]; } @@ -95680,9 +95684,9 @@ declare namespace Word { */ untrack(): Word.CustomProperty; /** - * 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.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyData`) 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.CustomProperty` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomPropertyData; } /** @@ -95702,8 +95706,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param key Required. The custom property's key, which is case-insensitive. - * @param value Required. The custom property's value. + * @param key The custom property's key, which is case-insensitive. + * @param value The custom property's value. */ add(key: string, value: any): Word.CustomProperty; /** @@ -95714,19 +95718,19 @@ declare namespace Word { */ deleteAll(): void; /** - * Gets the count of custom properties. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApi 1.3] */ getCount(): OfficeExtension.ClientResult; /** - * Gets a custom property object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property doesn't exist. + * Gets a `CustomProperty` object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property doesn't exist. * * @remarks * [Api set: WordApi 1.3] * - * @param key The key that identifies the custom property object. + * @param key The key that identifies the `CustomProperty` object. */ getItem(key: string): Word.CustomProperty; /** @@ -95735,7 +95739,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param key Required. The key that identifies the custom property object. + * @param key The key that identifies the custom property object. */ getItemOrNullObject(key: string): Word.CustomProperty; /** @@ -95765,9 +95769,9 @@ declare namespace Word { */ untrack(): Word.CustomPropertyCollection; /** - * 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.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.CustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomPropertyCollectionData; } /** @@ -95917,9 +95921,9 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single element in XPath notation. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". - * @param name Required. Name of the attribute. + * @param xpath Absolute path to the single element in XPath notation. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param name Name of the attribute. */ deleteAttribute(xpath: string, namespaceMappings: { [key: string]: string; @@ -95945,8 +95949,8 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single element in XPath notation. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param xpath Absolute path to the single element in XPath notation. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". */ deleteElement(xpath: string, namespaceMappings: { [key: string]: string; @@ -95979,10 +95983,10 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single element in XPath notation. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". - * @param name Required. Name of the attribute. - * @param value Required. Value of the attribute. + * @param xpath Absolute path to the single element in XPath notation. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param name Name of the attribute. + * @param value Value of the attribute. */ insertAttribute(xpath: string, namespaceMappings: { [key: string]: string; @@ -96008,9 +96012,9 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single parent element in XPath notation. - * @param xml Required. XML content to be inserted. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param xpath Absolute path to the single parent element in XPath notation. + * @param xml XML content to be inserted. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". * @param index Optional. Zero-based position at which the new XML to be inserted. If omitted, the XML will be appended as the last child of this parent. */ insertElement(xpath: string, xml: string, namespaceMappings: { @@ -96046,8 +96050,8 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. An XPath query. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param xpath An XPath query. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". * @returns An array where each item represents an entry matched by the XPath query. */ query(xpath: string, namespaceMappings: { @@ -96077,7 +96081,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param xml Required. XML content to be set. + * @param xml XML content to be set. */ setXml(xml: string): void; /** @@ -96101,10 +96105,10 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single element in XPath notation. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". - * @param name Required. Name of the attribute. - * @param value Required. New value of the attribute. + * @param xpath Absolute path to the single element in XPath notation. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param name Name of the attribute. + * @param value New value of the attribute. */ updateAttribute(xpath: string, namespaceMappings: { [key: string]: string; @@ -96130,9 +96134,9 @@ declare namespace Word { * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. * - * @param xpath Required. Absolute path to the single element in XPath notation. - * @param xml Required. New XML content to be stored. - * @param namespaceMappings Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param xpath Absolute path to the single element in XPath notation. + * @param xml New XML content to be stored. + * @param namespaceMappings An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". */ updateElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string; @@ -96167,9 +96171,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPart; /** - * 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.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartData`) 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.CustomXmlPart` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CustomXmlPartData; } /** @@ -96189,7 +96193,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param xml Required. XML content. Must be a valid XML fragment. + * @param xml XML content. Must be a valid XML fragment. */ add(xml: string): Word.CustomXmlPart; /** @@ -96198,7 +96202,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param namespaceUri Required. The namespace URI. + * @param namespaceUri The namespace URI. */ getByNamespace(namespaceUri: string): Word.CustomXmlPartScopedCollection; /** @@ -96223,7 +96227,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param id Required. ID of the object to be retrieved. + * @param id ID of the object to be retrieved. */ getItemOrNullObject(id: string): Word.CustomXmlPart; /** @@ -96253,9 +96257,9 @@ declare namespace Word { */ untrack(): Word.CustomXmlPartCollection; /** - * 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.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.CustomXmlPartCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlPartCollectionData; } /** @@ -96291,7 +96295,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param id Required. ID of the object to be retrieved. + * @param id ID of the object to be retrieved. */ getItemOrNullObject(id: string): Word.CustomXmlPart; /** @@ -96335,13 +96339,13 @@ declare namespace Word { */ untrack(): Word.CustomXmlPartScopedCollection; /** - * 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.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * 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.CustomXmlPartScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CustomXmlPartScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.CustomXmlPartScopedCollectionData; } /** - * 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. + * 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] @@ -96371,14 +96375,14 @@ declare namespace Word { */ readonly bibliography: Word.Bibliography; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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] */ readonly body: Word.Body; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks * [Api set: WordApi 1.1] @@ -96427,7 +96431,7 @@ declare namespace Word { */ readonly properties: Word.DocumentProperties; /** - * Gets the collection of section objects in the document. + * Gets the collection of `Section` objects in the document. * * @remarks * [Api set: WordApi 1.1] @@ -96490,7 +96494,7 @@ declare namespace Word { */ 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. + * 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] @@ -96510,8 +96514,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ addStyle(name: string, type: Word.StyleType): Word.Style; /** @@ -96520,30 +96524,30 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; /** * Closes the current document. - Note: This API isn't supported in Word on the web. + Note: This API isn't supported in Word on the web. * * @remarks * [Api set: WordApi 1.5] * - * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. + * @param closeBehavior Optional. The close behavior must be `save` or `skipSave`. Default value is `save`. */ close(closeBehavior?: Word.CloseBehavior): void; /** * Closes the current document. - Note: This API isn't supported in Word on the web. + Note: This API isn't supported in Word on the web. * * @remarks * [Api set: WordApi 1.5] * - * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. + * @param closeBehavior Optional. The close behavior must be `save` or `skipSave`. Default value is `save`. */ close(closeBehavior?: "Save" | "SkipSave"): void; /** @@ -96552,7 +96556,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.1] * - * @param filePath Required. The path of the document with which the specified document is compared. + * @param filePath The path of the document with which the specified document is compared. * @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document. */ compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void; @@ -96562,8 +96566,8 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param base64File Required. The Base64-encoded content of the document with which the specified document is compared. - * @param documentCompareOptions Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `CompareTargetSelected` in this API. + * @param base64File The Base64-encoded content of the document with which the specified document is compared. + * @param documentCompareOptions Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `compareTargetSelected` in this API. */ compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void; /** @@ -96572,7 +96576,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param name Required. The case-insensitive bookmark name. + * @param name The case-insensitive bookmark name. */ deleteBookmark(name: string): void; /** @@ -96597,7 +96601,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param name Required. The case-insensitive bookmark name. + * @param name The case-insensitive bookmark name. */ getBookmarkRange(name: string): Word.Range; /** @@ -96606,7 +96610,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param name Required. The case-insensitive bookmark name. + * @param name The case-insensitive bookmark name. */ getBookmarkRangeOrNullObject(name: string): Word.Range; /** @@ -96642,7 +96646,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] * - * @param id Required. Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. + * @param id Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. */ getParagraphByUniqueLocalId(id: string): Word.Paragraph; /** @@ -96653,7 +96657,7 @@ declare namespace Word { */ getSelection(): Word.Range; /** - * Gets a StyleCollection object that represents the whole style set of the document. + * Gets a `StyleCollection` object that represents the whole style set of the document. * * @remarks * [Api set: WordApi 1.5] @@ -96667,8 +96671,8 @@ declare namespace Word { * * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * - * @param stylesJson Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * @param stylesJson A JSON-formatted string representing the styles. + * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. The default value is `ignore`. */ importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; /** @@ -96679,8 +96683,8 @@ declare namespace Word { * * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. * - * @param stylesJson Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * @param stylesJson A JSON-formatted string representing the styles. + * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. The default value is `ignore`. */ importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult; /** @@ -96692,8 +96696,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; @@ -96712,7 +96716,7 @@ declare namespace Word { * * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. * - * @param saveBehavior Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. + * @param saveBehavior Optional. The save behavior must be `save` or `prompt`. Default value is `save`. * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; @@ -96724,15 +96728,18 @@ declare namespace Word { * * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. * - * @param saveBehavior Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. + * @param saveBehavior Optional. The save behavior must be `save` or `prompt`. Default value is `save`. * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; /** - * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.7] + * + * @param searchText The text to search for. + * @param searchOptions Optional. Options that define how the search is performed. */ search(searchText: string, searchOptions?: Word.SearchOptions | { ignorePunct?: boolean; @@ -96854,13 +96861,13 @@ declare namespace Word { */ untrack(): Word.Document; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Document` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Document` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.DocumentData; } /** - * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. + * 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] @@ -96869,14 +96876,14 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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] */ readonly body: Word.Body; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -96897,7 +96904,7 @@ declare namespace Word { */ readonly properties: Word.DocumentProperties; /** - * Gets the collection of section objects in the document. + * Gets the collection of `Section` objects in the document. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -96911,7 +96918,7 @@ declare namespace Word { */ readonly settings: Word.SettingCollection; /** - * 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. + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -96931,8 +96938,8 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.5] * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ addStyle(name: string, type: Word.StyleType): Word.Style; /** @@ -96941,8 +96948,8 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.5] * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * @param name A string representing the style name. + * @param type The style type, including character, list, paragraph, or table. */ addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; /** @@ -96951,7 +96958,7 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.4] * - * @param name Required. The case-insensitive bookmark name. + * @param name The case-insensitive bookmark name. */ deleteBookmark(name: string): void; /** @@ -96960,7 +96967,7 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.4] * - * @param name Required. The case-insensitive bookmark name. + * @param name The case-insensitive bookmark name. */ getBookmarkRange(name: string): Word.Range; /** @@ -96969,7 +96976,7 @@ declare namespace Word { * @remarks * [Api set: WordApiHiddenDocument 1.4] * - * @param name Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + * @param name The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ getBookmarkRangeOrNullObject(name: string): Word.Range; /** @@ -96986,7 +96993,7 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets a StyleCollection object that represents the whole style set of the document. + * Gets a `StyleCollection` object that represents the whole style set of the document. * * @remarks * [Api set: WordApiHiddenDocument 1.5] @@ -97001,8 +97008,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; @@ -97021,7 +97028,7 @@ declare namespace Word { * * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. * - * @param saveBehavior Optional. DocumentCreated only supports 'Save'. + * @param saveBehavior Optional. `DocumentCreated` only supports `save`. * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; @@ -97033,7 +97040,7 @@ declare namespace Word { * * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. * - * @param saveBehavior Optional. DocumentCreated only supports 'Save'. + * @param saveBehavior Optional. `DocumentCreated` only supports `save`. * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; @@ -97067,9 +97074,9 @@ declare namespace Word { */ untrack(): Word.DocumentCreated; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentCreated` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentCreatedData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentCreated` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentCreatedData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.DocumentCreatedData; } /** @@ -97245,13 +97252,13 @@ declare namespace Word { */ untrack(): Word.DocumentProperties; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentProperties` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentPropertiesData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.DocumentPropertiesData; } /** - * The data specific to content controls of type DropDownList. + * The data specific to content controls of type `dropDownList`. * * @remarks * [Api set: WordApi 1.9] @@ -97272,7 +97279,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.9] * - * @param displayText Required. Display text of the list item. + * @param displayText Display text of the list item. * @param value Optional. Value of the list item. * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. */ @@ -97314,7 +97321,7 @@ declare namespace Word { toJSON(): Word.Interfaces.DropDownListContentControlData; } /** - * The data specific to content controls of type 'ComboBox'. + * The data specific to content controls of type `comboBox`. * * @remarks * [Api set: WordApi 1.9] @@ -97335,7 +97342,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.9] * - * @param displayText Required. Display text of the list item. + * @param displayText Display text of the list item. * @param value Optional. Value of the list item. * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. */ @@ -97455,7 +97462,7 @@ declare namespace Word { */ 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. + * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks * [Api set: WordApi 1.5] @@ -97524,7 +97531,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -97533,7 +97540,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -97573,9 +97580,9 @@ declare namespace Word { */ untrack(): Word.Field; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Field` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Field` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.FieldData; } /** @@ -97608,12 +97615,12 @@ declare namespace Word { */ getFirstOrNullObject(): Word.Field; /** - * Gets the Field object collection including the specified types of fields. + * Gets the `FieldCollection` object including the specified types of fields. * * @remarks * [Api set: WordApi 1.5] * - * @param types Required. An array of field types. + * @param types An array of field types. */ getByTypes(types: Word.FieldType[]): Word.FieldCollection; /** @@ -97643,9 +97650,9 @@ declare namespace Word { */ untrack(): Word.FieldCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FieldCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FieldCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.FieldCollectionData; } /** @@ -97727,7 +97734,7 @@ declare namespace Word { */ allCaps: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -97747,7 +97754,7 @@ declare namespace Word { */ boldBidirectional: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApi 1.1] @@ -97789,7 +97796,7 @@ declare namespace Word { */ 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. + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -97829,21 +97836,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hidden: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * 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. + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -97877,7 +97884,7 @@ declare namespace Word { */ 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. + * Specifies the name of the font. * * @remarks * [Api set: WordApi 1.1] @@ -97966,7 +97973,7 @@ declare namespace Word { */ shadow: boolean; /** - * Specifies a value that represents the font size in points. + * Specifies the font size in points. * * @remarks * [Api set: WordApi 1.1] @@ -98000,7 +98007,7 @@ declare namespace Word { */ spacing: number; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -98014,21 +98021,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ subscript: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ superscript: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies the font's underline type. `none` if the font isn't underlined. * * @remarks * [Api set: WordApi 1.1] @@ -98107,9 +98114,9 @@ declare namespace Word { */ untrack(): Word.Font; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.FontData; } /** @@ -98212,9 +98219,9 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param fileName Required. The name of the file. - * @param editNow Required. `true` to start editing now. - * @param overwrite Required. `true` to overwrite if there's another file with the same name. + * @param fileName The name of the file. + * @param editNow `true` to start editing now. + * @param overwrite `true` to overwrite if there's another file with the same name. */ createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void; /** @@ -98254,9 +98261,9 @@ declare namespace Word { */ untrack(): Word.Hyperlink; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.HyperlinkData; } /** @@ -98276,7 +98283,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param anchor Required. The range to which the hyperlink is added. + * @param anchor The range to which the hyperlink is added. * @param options Optional. The options to further configure the new hyperlink. */ add(anchor: Word.Range, options?: Word.HyperlinkAddOptions): Word.Hyperlink; @@ -98307,9 +98314,9 @@ declare namespace Word { */ untrack(): Word.HyperlinkCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.HyperlinkCollectionData; } /** @@ -98504,7 +98511,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, or `end`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** @@ -98513,8 +98520,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param breakType Required. The break type to add. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param breakType The break type to add. + * @param insertLocation The value must be `before` or `after`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** @@ -98532,8 +98539,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `before` or `after`. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** @@ -98542,8 +98549,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param html Required. The HTML to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param html The HTML to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** @@ -98552,8 +98559,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'. + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertLocation The value must be `replace`, `before`, or `after`. */ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture; /** @@ -98562,8 +98569,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param ooxml Required. The OOXML to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param ooxml The OOXML to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** @@ -98572,8 +98579,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** @@ -98582,8 +98589,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param text Text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** @@ -98592,7 +98599,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -98601,7 +98608,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -98634,9 +98641,9 @@ declare namespace Word { */ untrack(): Word.InlinePicture; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.InlinePicture` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.InlinePicture` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.InlinePictureData; } /** @@ -98691,9 +98698,9 @@ declare namespace Word { */ untrack(): Word.InlinePictureCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.InlinePictureCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.InlinePictureCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.InlinePictureCollectionData; } /** @@ -98713,21 +98720,21 @@ declare namespace Word { */ readonly paragraphs: Word.ParagraphCollection; /** - * Gets the list's id. + * Gets the list's ID. * * @remarks * [Api set: WordApi 1.3] */ readonly id: 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. + * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks * [Api set: WordApi 1.3] */ readonly levelExistences: boolean[]; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. * * @remarks * [Api set: WordApi 1.3] @@ -98739,7 +98746,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.1] * - * @param level Required. The level in the list. + * @param level The level in the list. */ getLevelFont(level: number): Word.Font; /** @@ -98748,7 +98755,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. + * @param level The level in the list. */ getLevelParagraphs(level: number): Word.ParagraphCollection; /** @@ -98757,7 +98764,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.1] * - * @param level Required. The level in the list. + * @param level The level in the list. */ getLevelPicture(level: number): OfficeExtension.ClientResult; /** @@ -98766,7 +98773,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. + * @param level The level in the list. */ getLevelString(level: number): OfficeExtension.ClientResult; /** @@ -98775,8 +98782,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `start`, `end`, `before`, or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; /** @@ -98785,8 +98792,8 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.1] * - * @param level Required. The level in the list. - * @param resetFontName Optional. Indicates whether to reset the font name. Default is false that indicates the font name is kept unchanged. + * @param level The level in the list. + * @param resetFontName Optional. Indicates whether to reset the font name. Default is `false` that indicates the font name remains unchanged. */ resetLevelFont(level: number, resetFontName?: boolean): void; /** @@ -98795,8 +98802,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'. + * @param level The level in the list. + * @param alignment The level alignment that must be `left`, `centered`, or `right`. */ setLevelAlignment(level: number, alignment: Word.Alignment): void; /** @@ -98805,32 +98812,32 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'. + * @param level The level in the list. + * @param alignment The level alignment that must be `left`, `centered`, or `right`. */ setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void; /** - * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. + * Sets the bullet format at the specified level in the list. If the bullet is `custom`, the `charCode` is required. * * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param listBullet Required. The bullet. - * @param charCode Optional. The bullet character's code value. Used only if the bullet is 'Custom'. - * @param fontName Optional. The bullet's font name. Used only if the bullet is 'Custom'. + * @param level The level in the list. + * @param listBullet The bullet. + * @param charCode Optional. The bullet character's code value. Used only if the bullet is `custom`. + * @param fontName Optional. The bullet's font name. Used only if the bullet is `custom`. */ setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void; /** - * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. + * Sets the bullet format at the specified level in the list. If the bullet is `custom`, the `charCode` is required. * * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param listBullet Required. The bullet. - * @param charCode Optional. The bullet character's code value. Used only if the bullet is 'Custom'. - * @param fontName Optional. The bullet's font name. Used only if the bullet is 'Custom'. + * @param level The level in the list. + * @param listBullet The bullet. + * @param charCode Optional. The bullet character's code value. Used only if the bullet is `custom`. + * @param fontName Optional. The bullet's font name. Used only if the bullet is `custom`. */ setLevelBullet(level: number, listBullet: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void; /** @@ -98839,9 +98846,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param textIndent Required. The text indent in points. It is the same as paragraph left indent. - * @param bulletNumberPictureIndent Required. The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. + * @param level The level in the list. + * @param textIndent The text indent in points. It is the same as paragraph left indent. + * @param bulletNumberPictureIndent The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. */ setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; /** @@ -98850,9 +98857,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param listNumbering Required. The ordinal format. - * @param formatString Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. + * @param level The level in the list. + * @param listNumbering The ordinal format. + * @param formatString Optional. The numbering string format defined as an array of strings or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array): void; /** @@ -98861,9 +98868,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param listNumbering Required. The ordinal format. - * @param formatString Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. + * @param level The level in the list. + * @param listNumbering The ordinal format. + * @param formatString Optional. The numbering string format defined as an array of strings or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array): void; /** @@ -98872,7 +98879,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.1] * - * @param level Required. The level in the list. + * @param level The level in the list. * @param base64EncodedImage Optional. The Base64-encoded image to be set. If not given, the default picture is set. */ setLevelPicture(level: number, base64EncodedImage?: string): void; @@ -98882,8 +98889,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param level Required. The level in the list. - * @param startingNumber Required. The number to start with. + * @param level The level in the list. + * @param startingNumber The number to start with. */ setLevelStartingNumber(level: number, startingNumber: number): void; /** @@ -98916,9 +98923,9 @@ declare namespace Word { */ untrack(): Word.List; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.List` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.List` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListData; } /** @@ -98938,7 +98945,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param id Required. A list identifier. + * @param id A list identifier. */ getById(id: number): Word.List; /** @@ -98947,7 +98954,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param id Required. A list identifier. + * @param id A list identifier. */ getByIdOrNullObject(id: number): Word.List; /** @@ -98965,7 +98972,7 @@ declare namespace Word { */ getFirstOrNullObject(): Word.List; /** - * Gets a list object by its ID. + * Gets a `List` object by its ID. * * @remarks * [Api set: WordApi 1.3] @@ -99000,9 +99007,9 @@ declare namespace Word { */ untrack(): Word.ListCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ListCollectionData; } /** @@ -99049,7 +99056,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. + * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is `false` that specifies to get the lowest ancestor. */ getAncestor(parentOnly?: boolean): Word.Paragraph; /** @@ -99058,7 +99065,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. + * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is `false` that specifies to get the lowest ancestor. */ getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph; /** @@ -99067,7 +99074,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param directChildrenOnly Optional. Specifies only the list item's direct children will be returned. The default is false that indicates to get all descendant items. + * @param directChildrenOnly Optional. Specifies only the list item's direct children will be returned. The default is `false` that indicates to get all descendant items. */ getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection; /** @@ -99100,9 +99107,9 @@ declare namespace Word { */ untrack(): Word.ListItem; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListItemData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListItemData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListItemData; } /** @@ -99115,77 +99122,77 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets a Font object that represents the character formatting of the specified object. + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ readonly font: Word.Font; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * 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. + * Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ linkedStyle: string; /** - * Specifies the number format for the specified list level. + * Specifies the number format for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberFormat: string; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberPosition: number; /** - * Specifies the number style for the list level object. + * Specifies the number style for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the list level that must appear before it restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ resetOnHigher: number; /** - * Specifies the starting number for the specified list level object. + * Specifies the starting number for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ startAt: number; /** - * Specifies the tab position for the specified list level object. + * Specifies the tab position for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ tabPosition: number; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ textPosition: number; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the character inserted after the number for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -99229,9 +99236,9 @@ declare namespace Word { */ untrack(): Word.ListLevel; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListLevel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListLevel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListLevelData; } /** @@ -99286,9 +99293,9 @@ declare namespace Word { */ untrack(): Word.ListLevelCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListLevelCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListLevelCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListLevelCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ListLevelCollectionData; } /** @@ -99352,9 +99359,9 @@ declare namespace Word { */ untrack(): Word.ListTemplate; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListTemplate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ListTemplateData; } /** @@ -99446,9 +99453,9 @@ declare namespace Word { */ untrack(): Word.NoteItem; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.NoteItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.NoteItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.NoteItemData; } /** @@ -99503,9 +99510,9 @@ declare namespace Word { */ untrack(): Word.NoteItemCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.NoteItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.NoteItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.NoteItemCollectionData; } /** @@ -99565,7 +99572,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, or `end`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** @@ -99598,13 +99605,13 @@ declare namespace Word { */ untrack(): Word.Page; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.PageData; } /** - * Represents the collection of page. + * Represents the collection of {@link Word.Page} objects. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -99655,9 +99662,9 @@ declare namespace Word { */ untrack(): Word.PageCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.PageCollectionData; } /** @@ -99721,13 +99728,13 @@ declare namespace Word { */ untrack(): Word.Pane; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.PaneData; } /** - * Represents the collection of pane. + * Represents the collection of {@link Word.Pane} objects. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -99772,9 +99779,9 @@ declare namespace Word { */ untrack(): Word.PaneCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.PaneCollectionData; } /** @@ -99824,13 +99831,13 @@ declare namespace Word { */ untrack(): Word.Window; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.WindowData; } /** - * Represents the collection of window objects. + * Represents the collection of {@link Word.Window} objects. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -99875,9 +99882,9 @@ declare namespace Word { */ untrack(): Word.WindowCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.WindowCollectionData; } /** @@ -99897,7 +99904,7 @@ declare namespace Word { */ readonly borders: Word.BorderUniversalCollection; /** - * Gets the collection of content control objects in the paragraph. + * Gets the collection of `ContentControl` objects in the paragraph. * * @remarks * [Api set: WordApi 1.1] @@ -99932,7 +99939,7 @@ declare namespace Word { */ readonly footnotes: Word.NoteItemCollection; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * Gets the collection of `InlinePicture` objects in the paragraph. The collection doesn't include floating images. * * @remarks * [Api set: WordApi 1.1] @@ -100023,14 +100030,16 @@ declare namespace Word { */ readonly shading: Word.ShadingUniversal; /** - * 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. + * Gets the collection of `Shape` objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. */ readonly shapes: Word.ShapeCollection; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.1] @@ -100162,12 +100171,12 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param listId Required. The ID of an existing list. - * @param level Required. The level in the list. + * @param listId The ID of an existing list. + * @param level The level in the list. */ attachToList(listId: number, level: number): Word.List; /** - * Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content. + * Clears the contents of the `Paragraph` object. The user can perform the undo operation on the cleared content. * * @remarks * [Api set: WordApi 1.1] @@ -100188,7 +100197,7 @@ declare namespace Word { */ detachFromList(): void; /** - * Gets annotations set on this Paragraph object. + * Gets annotations set on this `Paragraph` object. * * @remarks * [Api set: WordApi 1.7] @@ -100217,7 +100226,7 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the `Paragraph` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. * * @remarks * [Api set: WordApi 1.1] @@ -100238,7 +100247,7 @@ declare namespace Word { */ getNextOrNullObject(): Word.Paragraph; /** - * Gets the Office Open XML (OOXML) representation of the paragraph object. + * Gets the Office Open XML (OOXML) representation of the `Paragraph` object. * * @remarks * [Api set: WordApi 1.1] @@ -100264,25 +100273,25 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `after`, or `content`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; /** - * Gets reviewed text based on ChangeTrackingVersion selection. + * Gets reviewed text based on `ChangeTrackingVersion` selection. * * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** - * Gets reviewed text based on ChangeTrackingVersion selection. + * Gets reviewed text based on `ChangeTrackingVersion` selection. * * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** @@ -100299,24 +100308,24 @@ declare namespace Word { IncludeTextMarkedAsDeleted?: boolean; }): OfficeExtension.ClientResult; /** - * Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks. + * Gets the text ranges in the paragraph by using punctuation marks and other ending marks. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Gets the collection of the TrackedChange objects in the paragraph. + * Gets the collection of the `TrackedChange` objects in the paragraph. * * @remarks * [Api set: WordApi 1.6] */ getTrackedChanges(): Word.TrackedChangeCollection; /** - * Inserts annotations on this Paragraph object. + * Inserts annotations on this `Paragraph` object. * * @remarks * [Api set: WordApi 1.7] @@ -100333,8 +100342,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param breakType Required. The break type to add to the document. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param breakType The break type to add to the document. + * @param insertLocation The value must be `before` or `after`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** @@ -100347,17 +100356,17 @@ declare namespace Word { */ insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Wraps the Paragraph object with a content control. + * Wraps the `Paragraph` object with a content control. * * @remarks * [Api set: WordApi 1.1] * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. - * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. + * `dropDownList` and `comboBox` support was added in WordApi 1.9. Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. * - * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + * @param contentControlType Optional. Content control type to insert. Must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. The default is `richText`. */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl; /** * Inserts a document into the paragraph at the specified location. * @@ -100366,8 +100375,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -100396,8 +100405,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param html Required. The HTML to be inserted in the paragraph. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param html The HTML to be inserted in the paragraph. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -100406,8 +100415,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; /** @@ -100416,8 +100425,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param ooxml Required. The OOXML to be inserted in the paragraph. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param ooxml The OOXML to be inserted in the paragraph. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -100426,8 +100435,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** @@ -100436,7 +100445,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. + * @param base64EncodedImage The Base64-encoded image to be inserted. * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. */ insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; @@ -100446,9 +100455,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `before` or `after`. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; @@ -100458,8 +100467,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @param text Text to be inserted. + * @param insertLocation The value must be `replace`, `start`, or `end`. */ insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** @@ -100473,12 +100482,12 @@ declare namespace Word { */ insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the `Paragraph` object. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.1] * - * @param searchText Required. The search text. + * @param searchText The search text. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -100496,7 +100505,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -100505,7 +100514,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -100514,9 +100523,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param delimiters Required. The delimiters as an array of strings. - * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param delimiters The delimiters as an array of strings. + * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is `false` which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; /** @@ -100556,9 +100565,9 @@ declare namespace Word { */ untrack(): Word.Paragraph; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Paragraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Paragraph` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ParagraphData; } /** @@ -100627,9 +100636,9 @@ declare namespace Word { */ untrack(): Word.ParagraphCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ParagraphCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ParagraphCollectionData; } /** @@ -100777,9 +100786,9 @@ declare namespace Word { */ untrack(): Word.ParagraphFormat; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ParagraphFormatData; } /** @@ -100792,7 +100801,7 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the collection of content control objects in the range. + * Gets the collection of `ContentControl` objects in the range. * * @remarks * [Api set: WordApi 1.1] @@ -100806,7 +100815,7 @@ declare namespace Word { */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the range. + * Gets the collection of `Field` objects in the range. * * @remarks * [Api set: WordApi 1.4] @@ -100841,7 +100850,7 @@ declare namespace Word { */ readonly hyperlinks: Word.HyperlinkCollection; /** - * Gets the collection of inline picture objects in the range. + * Gets the collection of `InlinePicture` objects in the range. * * @remarks * [Api set: WordApi 1.2] @@ -100855,7 +100864,7 @@ declare namespace Word { */ readonly listFormat: Word.ListFormat; /** - * Gets the collection of list objects in the range. + * Gets the collection of `List` objects in the range. * * @remarks * [Api set: WordApi 1.3] @@ -100869,7 +100878,7 @@ declare namespace Word { */ readonly pages: Word.PageCollection; /** - * Gets the collection of paragraph objects in the range. + * Gets the collection of `Paragraph` objects in the range. * * @remarks * [Api set: WordApi 1.1] @@ -100941,10 +100950,12 @@ declare namespace Word { */ readonly shading: Word.ShadingUniversal; /** - * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Gets the 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: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. */ readonly shapes: Word.ShapeCollection; /** @@ -100955,7 +100966,7 @@ declare namespace Word { */ readonly tableColumns: Word.TableColumnCollection; /** - * Gets the collection of table objects in the range. + * Gets the collection of `Table` objects in the range. * * @remarks * [Api set: WordApi 1.3] @@ -101040,7 +101051,7 @@ declare namespace Word { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Word.Range): void; /** - * Clears the contents of the range object. The user can perform the undo operation on the cleared content. + * Clears the contents of the `Range` object. The user can perform the undo operation on the cleared content. * * @remarks * [Api set: WordApi 1.1] @@ -101052,7 +101063,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param range Required. The range to compare with this range. + * @param range The range to compare with this range. */ compareLocationWith(range: Word.Range): OfficeExtension.ClientResult; /** @@ -101075,7 +101086,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param range Required. Another range. + * @param range Another range. */ expandTo(range: Word.Range): Word.Range; /** @@ -101084,7 +101095,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param range Required. Another range. + * @param range Another range. */ expandToOrNullObject(range: Word.Range): Word.Range; /** @@ -101093,8 +101104,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param includeHidden Optional. Indicates whether to include hidden bookmarks. Default is false which indicates that the hidden bookmarks are excluded. - * @param includeAdjacent Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is false which indicates that the adjacent bookmarks are excluded. + * @param includeHidden Optional. Indicates whether to include hidden bookmarks. Default is `false` which indicates that the hidden bookmarks are excluded. + * @param includeAdjacent Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is `false` which indicates that the adjacent bookmarks are excluded. */ getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult; /** @@ -101102,7 +101113,7 @@ declare namespace Word { * * @remarks * [Api set: WordApi 1.4] - * @returns + * @returns A `CommentCollection` object that contains all the comments associated with the range. */ getComments(): Word.CommentCollection; /** @@ -101119,7 +101130,7 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the `Range` object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. * * @remarks * [Api set: WordApi 1.1] @@ -101133,39 +101144,39 @@ declare namespace Word { */ getHyperlinkRanges(): Word.RangeCollection; /** - * Gets the next text range by using punctuation marks and/or other ending marks. Throws an `ItemNotFound` error if this text range is the last one. + * Gets the next text range by using punctuation marks and other ending marks. Throws an `ItemNotFound` error if this text range is the last one. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is `false` which indicates that spacing characters at the start and end of the range are included. */ getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range; /** - * Gets the next text range by using punctuation marks and/or other ending marks. If this text range is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets the next text range by using punctuation marks and other ending marks. If this text range is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is `false` which indicates that spacing characters at the start and end of the range are included. */ getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range; /** - * Gets the OOXML representation of the range object. + * Gets the OOXML representation of the `Range` object. * * @remarks * [Api set: WordApi 1.1] */ getOoxml(): OfficeExtension.ClientResult; /** - * Clones the range, or gets the starting or ending point of the range as a new range. + * Clones the `Range` object, or gets the starting or ending point of the range as a new range. * * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, `after`, or `content`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; /** @@ -101174,7 +101185,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** @@ -101183,21 +101194,21 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * @param changeTrackingVersion Optional. The value must be `original` or `current`. The default is `current`. */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Gets the text child ranges in the range by using punctuation marks and/or other ending marks. + * Gets the text child ranges in the range by using punctuation marks and other ending marks. * * @remarks * [Api set: WordApi 1.3] * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param endingMarks The punctuation marks and other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Gets the collection of the TrackedChange objects in the range. + * Gets the collection of the `TrackedChange` objects in the range. * * @remarks * [Api set: WordApi 1.6] @@ -101205,7 +101216,7 @@ declare namespace Word { getTrackedChanges(): Word.TrackedChangeCollection; /** * Highlights the range temporarily without changing document content. - To highlight the text permanently, set the range's Font.HighlightColor. + To highlight the text permanently, set the range's `font.highlightColor`. * * @remarks * [Api set: WordApi 1.8] @@ -101219,7 +101230,7 @@ declare namespace Word { * * Note: The conditions of inserting a bookmark are similar to doing so in the Word UI. To learn more about managing bookmarks in the Word UI, see {@link https://support.microsoft.com/office/f68d781f-0150-4583-a90e-a4009d99c2a0 | Add or delete bookmarks in a Word document or Outlook message}. * - * @param name Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + * @param name The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ insertBookmark(name: string): void; /** @@ -101228,8 +101239,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param breakType Required. The break type to add. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param breakType The break type to add. + * @param insertLocation The value must be `before` or `after`. */ insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** @@ -101247,22 +101258,22 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param commentText Required. The comment text to be inserted. - * @returns comment object + * @param commentText The comment text to be inserted. + * @returns The `Comment` object that was inserted. */ insertComment(commentText: string): Word.Comment; /** - * Wraps the Range object with a content control. + * Wraps the `Range` object with a content control. * * @remarks * [Api set: WordApi 1.1] * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. - * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `plainText` support was added in WordApi 1.5. `checkBox` support was added in WordApi 1.7. + * `dropDownList` and `comboBox` support was added in WordApi 1.9. Support for `buildingBlockGallery`, `datePicker`, `group`, `picture`, and `repeatingSection` was added in WordApiDesktop 1.3. * - * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + * @param contentControlType Optional. Content control type to insert. Must be `richText`, `plainText`, `checkBox`, `dropDownList`, `comboBox`, `buildingBlockGallery`, `datePicker`, `repeatingSection`, `picture`, or `group`. The default is `richText`. */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl; /** * Inserts an endnote. The endnote reference is placed after the range. * @@ -101279,10 +101290,10 @@ declare namespace Word { * [Api set: WordApi 1.5] * * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. - * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. * - * @param insertLocation Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. - * @param fieldType Optional. Can be any FieldType constant. The default value is Empty. + * @param insertLocation The location relative to the range where the field will be inserted. The value must be `replace`, `start`, `end`, `before`, or `after`. + * @param fieldType Optional. Can be any `FieldType` value. The default value is `empty`. * @param text Optional. Additional properties or options if needed for specified field type. * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. */ @@ -101294,10 +101305,10 @@ declare namespace Word { * [Api set: WordApi 1.5] * * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. - * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. * - * @param insertLocation Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. - * @param fieldType Optional. Can be any FieldType constant. The default value is Empty. + * @param insertLocation The location relative to the range where the field will be inserted. The value must be `replace`, `start`, `end`, `before`, or `after`. + * @param fieldType Optional. Can be any `FieldType` value. The default value is `empty`. * @param text Optional. Additional properties or options if needed for specified field type. * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. */ @@ -101310,8 +101321,8 @@ declare namespace Word { * * Insertion isn't supported if the document being inserted contains an ActiveX control (likely in a form field). Consider replacing such a form field with a content control or other option appropriate for your scenario. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param base64File The Base64-encoded content of a .docx file. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** @@ -101349,8 +101360,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param html Required. The HTML to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param html The HTML to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** @@ -101359,8 +101370,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture; /** @@ -101369,8 +101380,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param ooxml Required. The OOXML to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param ooxml The OOXML to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** @@ -101379,8 +101390,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** @@ -101389,8 +101400,8 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertShapeOptions Required. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. + * @param base64EncodedImage The Base64-encoded image to be inserted. + * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. */ insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** @@ -101399,9 +101410,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `before` or `after`. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; @@ -101411,8 +101422,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param text Text to be inserted. + * @param insertLocation The value must be `replace`, `start`, `end`, `before`, or `after`. */ insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** @@ -101431,7 +101442,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param range Required. Another range. + * @param range Another range. */ intersectWith(range: Word.Range): Word.Range; /** @@ -101440,23 +101451,23 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param range Required. Another range. + * @param range Another range. */ intersectWithOrNullObject(range: Word.Range): Word.Range; /** - * Removes the highlight added by the Highlight function if any. + * Removes the highlight added by the `highlight` method if any. * * @remarks * [Api set: WordApi 1.8] */ removeHighlight(): void; /** - * Performs a search with the specified SearchOptions on the scope of the range object. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the `Range` object. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.1] * - * @param searchText Required. The search text. + * @param searchText The search text. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -101474,7 +101485,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -101483,7 +101494,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -101492,10 +101503,10 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param delimiters Required. The delimiters as an array of strings. - * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters. - * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param delimiters The delimiters as an array of strings. + * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is `false` which indicates that the paragraph boundaries are also used as delimiters. + * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is `false` which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is `false` which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; /** @@ -101528,9 +101539,9 @@ declare namespace Word { */ untrack(): Word.Range; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Range` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Range` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.RangeData; } /** @@ -101585,9 +101596,9 @@ declare namespace Word { */ untrack(): Word.RangeCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.RangeCollectionData; } /** @@ -101598,28 +101609,28 @@ declare namespace Word { */ interface InsertShapeOptions { /** - * Represents the height of the shape being inserted. + * If provided, specifies the height of the shape being inserted. * * @remarks * [Api set: WordApiDesktop 1.2] */ height?: number; /** - * Represents the left position of the shape being inserted. + * If provided, specifies the left position of the shape being inserted. * * @remarks * [Api set: WordApiDesktop 1.2] */ left?: number; /** - * Represents the top position of the shape being inserted. + * If provided, specifies the top position of the shape being inserted. * * @remarks * [Api set: WordApiDesktop 1.2] */ top?: number; /** - * Represents the width of the shape being inserted. + * If provided, specifies the width of the shape being inserted. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -101634,56 +101645,56 @@ declare namespace Word { */ interface InsertFileOptions { /** - * Represents whether the change tracking mode status from the source document should be imported. + * If provided, specifies whether the change tracking mode status from the source document should be imported. * * @remarks * [Api set: WordApi 1.5] */ importChangeTrackingMode?: boolean; /** - * Represents whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. + * If provided, specifies whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. * * @remarks * [Api set: WordApi 1.6] */ importCustomProperties?: boolean; /** - * Represents whether the custom XML parts from the source document should be imported. + * If provided, specifies whether the custom XML parts from the source document should be imported. * * @remarks * [Api set: WordApi 1.6] */ importCustomXmlParts?: boolean; /** - * Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document. + * If provided, specifies whether to import the Different Odd and Even Pages setting for the header and footer from the source document. * * @remarks * [Api set: WordApi 1.7] */ importDifferentOddEvenPages?: boolean; /** - * Represents whether the page color and other background information from the source document should be imported. + * If provided, specifies whether the page color and other background information from the source document should be imported. * * @remarks * [Api set: WordApi 1.5] */ importPageColor?: boolean; /** - * Represents whether the paragraph spacing from the source document should be imported. + * If provided, specifies whether the paragraph spacing from the source document should be imported. * * @remarks * [Api set: WordApi 1.5] */ importParagraphSpacing?: boolean; /** - * Represents whether the styles from the source document should be imported. + * If provided, specifies whether the styles from the source document should be imported. * * @remarks * [Api set: WordApi 1.5] */ importStyles?: boolean; /** - * Represents whether the theme from the source document should be imported. + * If provided, specifies whether the theme from the source document should be imported. * * @remarks * [Api set: WordApi 1.5] @@ -101701,49 +101712,49 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies a 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. + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignorePunct: boolean; /** - * 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. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignoreSpace: boolean; /** - * 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. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchCase: boolean; /** - * 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. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchPrefix: boolean; /** - * 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. + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchSuffix: boolean; /** - * 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. + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchWholeWord: boolean; /** - * 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. + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] @@ -101783,27 +101794,27 @@ declare namespace Word { */ static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SearchOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SearchOptionsData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SearchOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SearchOptionsData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.SearchOptionsData; } /** - * Specifies the options to be included in a getText operation. + * Specifies the options to be included in a {@link Word.Paragraph | Paragraph.getText} operation. * * @remarks * [Api set: WordApi 1.7] */ interface GetTextOptions { /** - * Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False. + * If provided, specifies whether to include hidden text in the result of the `Paragraph.getText` method. The default value is `false`. * * @remarks * [Api set: WordApi 1.7] */ includeHiddenText?: boolean; /** - * Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False. + * If provided, specifies whether to include text marked as deleted in the result of the `Paragraph.getText` method. The default value is `false`. * * @remarks * [Api set: WordApi 1.7] @@ -101818,50 +101829,50 @@ declare namespace Word { */ interface DocumentCompareOptions { /** - * True adds the document to the list of recently used files on the File menu. The default value is True. + * If provided, specifies whether to add the document to the list of recently used files on the **File** menu. The default value is `true`. * * @remarks * [Api set: WordApiDesktop 1.1] */ addToRecentFiles?: boolean; /** - * The reviewer name associated with the differences generated by the comparison. - If unspecified, the value defaults to the author name of the revised document or the string "Comparison" if no author information is present. + * If provided, specifies the reviewer name associated with the differences generated by the comparison. + If unspecified, the value defaults to the author name of the revised document or the string `Comparison` if no author information is present. * * @remarks * [Api set: WordApiDesktop 1.1] */ authorName?: string; /** - * The target document for the comparison. Default value is 'CompareTargetCurrent'. + * If provided, specifies the target document for the comparison. Default value is `compareTargetCurrent`. * * @remarks * [Api set: WordApiDesktop 1.1] */ compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"; /** - * True (default) for the comparison to include detection of format changes. + * If provided, specifies whether the comparison should include detection of format changes. The default value is `true`. * * @remarks * [Api set: WordApiDesktop 1.1] */ detectFormatChanges?: boolean; /** - * True compares the documents without notifying a user of problems. The default value is False. + * If provided, specifies whether to compare the documents without notifying a user of problems. The default value is `false`. * * @remarks * [Api set: WordApiDesktop 1.1] */ ignoreAllComparisonWarnings?: boolean; /** - * True removes date and time stamp information from tracked changes in the returned Document object. The default value is False. + * If provided, specifies whether to remove date and time stamp information from tracked changes in the returned `Document` object. The default value is `false`. * * @remarks * [Api set: WordApiDesktop 1.1] */ removeDateAndTime?: boolean; /** - * True removes all user information from comments, revisions, and the properties dialog box in the returned Document object. The default value is False. + * If provided, specifies whether to remove all user information from comments, revisions, and the properties dialog box in the returned `Document` object. The default value is `false`. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -101878,7 +101889,7 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. * * @remarks * [Api set: WordApi 1.1] @@ -101919,7 +101930,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * @param type The type of footer to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ getFooter(type: Word.HeaderFooterType): Word.Body; /** @@ -101928,7 +101939,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * @param type The type of footer to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; /** @@ -101937,7 +101948,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * @param type The type of header to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ getHeader(type: Word.HeaderFooterType): Word.Body; /** @@ -101946,7 +101957,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.1] * - * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * @param type The type of header to return. This value must be: `primary`, `firstPage`, or `evenPages`. */ getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; /** @@ -101993,9 +102004,9 @@ declare namespace Word { */ untrack(): Word.Section; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Section` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Section` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.SectionData; } /** @@ -102050,9 +102061,9 @@ declare namespace Word { */ untrack(): Word.SectionCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SectionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SectionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.SectionCollectionData; } /** @@ -102123,9 +102134,9 @@ declare namespace Word { */ untrack(): Word.Setting; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Setting` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Setting` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.SettingData; } /** @@ -102145,8 +102156,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param key Required. The setting's key, which is case-sensitive. - * @param value Required. The setting's value. + * @param key The setting's key, which is case-sensitive. + * @param value The setting's value. */ add(key: string, value: any): Word.Setting; /** @@ -102157,28 +102168,28 @@ declare namespace Word { */ deleteAll(): void; /** - * Gets the count of settings. + * Gets the number of items in the collection. * * @remarks * [Api set: WordApi 1.4] */ getCount(): OfficeExtension.ClientResult; /** - * Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. + * Gets a `Setting` object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. * * @remarks * [Api set: WordApi 1.4] * - * @param key The key that identifies the setting object. + * @param key The key that identifies the `Setting` object. */ getItem(key: string): Word.Setting; /** - * Gets a setting object by its key, which is case-sensitive. If the setting doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * Gets a `Setting` object by its key, which is case-sensitive. If the setting doesn't exist, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApi 1.4] * - * @param key Required. The key that identifies the setting object. + * @param key The key that identifies the `Setting` object. */ getItemOrNullObject(key: string): Word.Setting; /** @@ -102208,9 +102219,9 @@ declare namespace Word { */ untrack(): Word.SettingCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SettingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SettingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.SettingCollectionData; } /** @@ -102225,12 +102236,12 @@ declare namespace Word { /** Gets the loaded child items in this collection. */ readonly items: Word.Style[]; /** - * Get the style object by its name. + * Get the `Style` object by its name. * * @remarks * [Api set: WordApi 1.5] * - * @param name Required. The style name. + * @param name The style name. */ getByName(name: string): Word.Style; /** @@ -102239,23 +102250,23 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] * - * @param name Required. The style name. + * @param name The style name. */ getByNameOrNullObject(name: string): Word.Style; /** - * Gets the number of the styles in the collection. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApi 1.5] */ getCount(): OfficeExtension.ClientResult; /** - * Gets a style object by its index in the collection. + * Gets a `Style` object by its index in the collection. * * @remarks * [Api set: WordApi 1.5] * - * @param index A number that identifies the index location of a style object. + * @param index The location of a `Style` object. */ getItem(index: number): Word.Style; /** @@ -102285,9 +102296,9 @@ declare namespace Word { */ untrack(): Word.StyleCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.StyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.StyleCollectionData; } /** @@ -102300,14 +102311,14 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Specifies a `BorderCollection` object that represents all the borders for the style. * * @remarks * [Api set: WordApiDesktop 1.1] */ readonly borders: Word.BorderCollection; /** - * Gets a font object that represents the character formatting of the specified style. + * Gets a `Font` object that represents the character formatting of the style. * * @remarks * [Api set: WordApi 1.5] @@ -102328,28 +102339,28 @@ declare namespace Word { */ linkStyle: Word.Style; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Gets a `ListTemplate` object that represents the list formatting for the style. * * @remarks * [Api set: WordApiDesktop 1.1] */ readonly listTemplate: Word.ListTemplate; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. * * @remarks * [Api set: WordApi 1.5] */ readonly paragraphFormat: Word.ParagraphFormat; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. * * @remarks * [Api set: WordApi 1.6] */ readonly shading: Word.Shading; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Gets a `TableStyle` object representing style properties that can be applied to a table. * * @remarks * [Api set: WordApi 1.6] @@ -102372,7 +102383,7 @@ declare namespace Word { */ baseStyle: string; /** - * Gets whether the specified style is a built-in style. + * Gets whether the style is a built-in style. * * @remarks * [Api set: WordApi 1.5] @@ -102386,7 +102397,7 @@ declare namespace Word { */ hasProofing: boolean; /** - * 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. + * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks * [Api set: WordApi 1.5] @@ -102407,7 +102418,7 @@ declare namespace Word { */ 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 whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks * [Api set: WordApi 1.5] @@ -102428,14 +102439,14 @@ declare namespace Word { */ locked: boolean; /** - * Gets the name of a style in the language of the user. + * Gets the name of the style in the language of the user. * * @remarks * [Api set: WordApi 1.5] */ readonly nameLocal: string; /** - * 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 name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks * [Api set: WordApi 1.5] @@ -102472,14 +102483,14 @@ declare namespace Word { */ readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * 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 whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks * [Api set: WordApi 1.5] */ unhideWhenUsed: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] @@ -102539,13 +102550,13 @@ declare namespace Word { */ untrack(): Word.Style; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Style` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Style` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.StyleData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.StyleData; } /** - * Represents the shading object. + * Represents the `Shading` object. * * @remarks * [Api set: WordApi 1.6] @@ -102612,9 +102623,9 @@ declare namespace Word { */ untrack(): Word.Shading; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Shading` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Shading` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShadingData; } /** @@ -102699,9 +102710,9 @@ declare namespace Word { */ untrack(): Word.ShadingUniversal; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShadingUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingUniversalData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShadingUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingUniversalData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShadingUniversalData; } /** @@ -102721,7 +102732,7 @@ declare namespace Word { */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the table. + * Gets the collection of `Field` objects in the table. * * @remarks * [Api set: WordApi 1.4] @@ -102805,7 +102816,7 @@ declare namespace Word { */ readonly tables: Word.TableCollection; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApi 1.3] @@ -102819,7 +102830,7 @@ declare namespace Word { */ headerRowCount: number; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] @@ -102910,7 +102921,7 @@ declare namespace Word { */ values: string[][]; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -102937,8 +102948,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table. - * @param columnCount Required. Number of columns to add. + * @param insertLocation It must be `start` or `end`, corresponding to the appropriate side of the table. + * @param columnCount Number of columns to add. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void; @@ -102948,8 +102959,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. It must be 'Start' or 'End'. - * @param rowCount Required. Number of rows to add. + * @param insertLocation It must be `start` or `end`. + * @param rowCount Number of rows to add. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; @@ -102980,7 +102991,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param columnIndex Required. The first column to delete. + * @param columnIndex The first column to delete. * @param columnCount Optional. The number of columns to delete. Default 1. */ deleteColumns(columnIndex: number, columnCount?: number): void; @@ -102990,7 +103001,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowIndex Required. The first row to delete. + * @param rowIndex The first row to delete. * @param rowCount Optional. The number of rows to delete. Default 1. */ deleteRows(rowIndex: number, rowCount?: number): void; @@ -103007,7 +103018,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** @@ -103016,7 +103027,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** @@ -103025,8 +103036,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowIndex Required. The index of the row. - * @param cellIndex Required. The index of the cell in the row. + * @param rowIndex The index of the row. + * @param cellIndex The index of the cell in the row. */ getCell(rowIndex: number, cellIndex: number): Word.TableCell; /** @@ -103035,8 +103046,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowIndex Required. The index of the row. - * @param cellIndex Required. The index of the cell in the row. + * @param rowIndex The index of the row. + * @param cellIndex The index of the cell in the row. */ getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell; /** @@ -103045,7 +103056,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** @@ -103054,7 +103065,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** @@ -103105,7 +103116,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'. + * @param rangeLocation Optional. The range location must be `whole`, `start`, `end`, or `after`. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range; /** @@ -103121,8 +103132,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param paragraphText The paragraph text to be inserted. + * @param insertLocation The value must be `before` or `after`. */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** @@ -103131,9 +103142,9 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param rowCount The number of rows in the table. + * @param columnCount The number of columns in the table. + * @param insertLocation The value must be `before` or `after`. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; @@ -103143,19 +103154,19 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param topRow Required. The row of the first cell - * @param firstCell Required. The index of the first cell in its row - * @param bottomRow Required. The row of the last cell - * @param lastCell Required. The index of the last cell in its row + * @param topRow The row of the first cell. + * @param firstCell The index of the first cell in its row. + * @param bottomRow The row of the last cell. + * @param lastCell The index of the last cell in its row. */ mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; /** - * Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the `Table` object. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.3] * - * @param searchText Required. The search text. + * @param searchText The search text. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -103173,7 +103184,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -103182,7 +103193,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -103191,8 +103202,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** @@ -103201,8 +103212,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** @@ -103235,13 +103246,13 @@ declare namespace Word { */ untrack(): Word.Table; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableData; } /** - * Represents the TableStyle object. + * Represents the `TableStyle` object. * * @remarks * [Api set: WordApi 1.6] @@ -103257,7 +103268,7 @@ declare namespace Word { */ alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -103336,13 +103347,13 @@ declare namespace Word { */ untrack(): Word.TableStyle; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableStyleData; } /** - * Contains the collection of the document's Table objects. + * Contains the collection of the document's {@link Word.Table} objects. * * @remarks * [Api set: WordApi 1.3] @@ -103393,9 +103404,9 @@ declare namespace Word { */ untrack(): Word.TableCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableCollectionData; } /** @@ -103557,9 +103568,9 @@ declare namespace Word { */ untrack(): Word.TableColumn; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableColumnData; } /** @@ -103658,9 +103669,9 @@ declare namespace Word { */ untrack(): Word.TableColumnCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableColumnCollectionData; } /** @@ -103687,7 +103698,7 @@ declare namespace Word { */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the table row. + * Gets the collection of `Field` objects in the table row. * * @remarks * [Api set: WordApi 1.4] @@ -103722,14 +103733,14 @@ declare namespace Word { */ readonly cellCount: number; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] */ horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks * [Api set: WordApi 1.3] @@ -103764,7 +103775,7 @@ declare namespace Word { */ values: string[][]; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -103798,7 +103809,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** @@ -103807,7 +103818,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** @@ -103816,7 +103827,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** @@ -103825,7 +103836,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** @@ -103855,8 +103866,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. - * @param rowCount Required. Number of rows to add + * @param insertLocation Where the new rows should be inserted, relative to the current row. It must be `before` or `after`. + * @param rowCount Number of rows to add. * @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. */ insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; @@ -103868,12 +103879,12 @@ declare namespace Word { */ merge(): Word.TableCell; /** - * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. + * Performs a search with the specified search options on the scope of the row. The search results are a collection of `Range` objects. * * @remarks * [Api set: WordApi 1.3] * - * @param searchText Required. The search text. + * @param searchText The search text. * @param searchOptions Optional. Options for the search. */ search(searchText: string, searchOptions?: Word.SearchOptions | { @@ -103891,7 +103902,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: Word.SelectionMode): void; /** @@ -103900,7 +103911,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param selectionMode Optional. The selection mode must be `select`, `start`, or `end`. `select` is the default. */ select(selectionMode?: "Select" | "Start" | "End"): void; /** @@ -103909,8 +103920,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** @@ -103919,8 +103930,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** @@ -103953,13 +103964,13 @@ declare namespace Word { */ untrack(): Word.TableRow; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableRowData; } /** - * Contains the collection of the document's TableRow objects. + * Contains the collection of the document's {@link Word.TableRow} objects. * * @remarks * [Api set: WordApi 1.3] @@ -104010,9 +104021,9 @@ declare namespace Word { */ untrack(): Word.TableRowCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableRowCollectionData; } /** @@ -104025,7 +104036,7 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the body object of the cell. + * Gets the `Body` object of the cell. * * @remarks * [Api set: WordApi 1.3] @@ -104060,7 +104071,7 @@ declare namespace Word { */ columnWidth: number; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -104088,7 +104099,7 @@ declare namespace Word { */ value: string; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -104129,7 +104140,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** @@ -104138,7 +104149,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param borderLocation Required. The border location. + * @param borderLocation The border location. */ getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** @@ -104147,7 +104158,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** @@ -104156,7 +104167,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. */ getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** @@ -104179,8 +104190,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. It must be 'Before' or 'After'. - * @param columnCount Required. Number of columns to add. + * @param insertLocation It must be `before` or `after`. + * @param columnCount Number of columns to add. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; @@ -104190,8 +104201,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. It must be 'Before' or 'After'. - * @param rowCount Required. Number of rows to add. + * @param insertLocation It must be `before` or `after`. + * @param rowCount Number of rows to add. * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; @@ -104201,8 +104212,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** @@ -104211,8 +104222,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.3] * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param cellPaddingLocation The cell padding location must be `top`, `left`, `bottom`, or `right`. + * @param cellPadding The cell padding. */ setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** @@ -104221,8 +104232,8 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.4] * - * @param rowCount Required. The number of rows to split into. Must be a divisor of the number of underlying rows. - * @param columnCount Required. The number of columns to split into. + * @param rowCount The number of rows to split into. Must be a divisor of the number of underlying rows. + * @param columnCount The number of columns to split into. */ split(rowCount: number, columnCount: number): void; /** @@ -104255,13 +104266,13 @@ declare namespace Word { */ untrack(): Word.TableCell; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableCellData; } /** - * Contains the collection of the document's TableCell objects. + * Contains the collection of the document's {@link Word.TableCell} objects. * * @remarks * [Api set: WordApi 1.3] @@ -104312,9 +104323,9 @@ declare namespace Word { */ untrack(): Word.TableCellCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TableCellCollectionData; } /** @@ -104385,9 +104396,9 @@ declare namespace Word { */ untrack(): Word.TableBorder; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TableBorderData; } /** @@ -104556,9 +104567,9 @@ declare namespace Word { */ untrack(): Word.Template; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TemplateData; } /** @@ -104587,7 +104598,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param index The index of the template to retrieve. + * @param index The index of the item to retrieve. */ getItemAt(index: number): Word.Template; /** @@ -104624,9 +104635,9 @@ declare namespace Word { */ untrack(): Word.TemplateCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TemplateCollectionData; } /** @@ -104692,6 +104703,8 @@ declare namespace Word { * * @remarks * [Api set: WordApi 1.6] + * + * @param rangeLocation Optional. Specifies the part of the tracked change to get the range for. If not specified, the whole range of the tracked change is returned. */ getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** @@ -104731,9 +104744,9 @@ declare namespace Word { */ untrack(): Word.TrackedChange; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TrackedChangeData; } /** @@ -104802,9 +104815,9 @@ declare namespace Word { */ untrack(): Word.TrackedChangeCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TrackedChangeCollectionData; } /** @@ -104817,14 +104830,14 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] */ readonly body: Word.Body; /** - * 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}. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -104852,14 +104865,14 @@ declare namespace Word { */ readonly parentGroup: Word.Shape; /** - * 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}. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. * * @remarks * [Api set: WordApiDesktop 1.2] */ readonly shapeGroup: Word.ShapeGroup; /** - * Gets the text frame object of the shape. + * Gets the `TextFrame` object of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105047,7 +105060,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param distance Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. + * @param distance Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. */ moveHorizontally(distance: number): void; /** @@ -105056,7 +105069,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. + * @param distance Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. */ moveVertically(distance: number): void; /** @@ -105109,7 +105122,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is false. + * @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is `false`. */ select(selectMultipleShapes?: boolean): void; /** @@ -105142,13 +105155,13 @@ declare namespace Word { */ untrack(): Word.Shape; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShapeData; } /** - * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. + * Represents a shape group in the document. To get the corresponding {@link Word.Shape} object, use `ShapeGroup.shape`. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105157,14 +105170,14 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Shape object associated with the group. + * Gets the `Shape` object associated with the group. * * @remarks * [Api set: WordApiDesktop 1.2] */ readonly shape: Word.Shape; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Gets the collection of `Shape` objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105222,13 +105235,13 @@ declare namespace Word { */ untrack(): Word.ShapeGroup; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShapeGroupData; } /** - * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * Represents a canvas in the document. To get the corresponding {@link Word.Shape} object, use `Canvas.shape`. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105237,14 +105250,14 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Gets the Shape object associated with the canvas. + * Gets the `Shape` object associated with the canvas. * * @remarks * [Api set: WordApiDesktop 1.2] */ readonly shape: Word.Shape; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Gets the collection of {@link Word.Shape} objects. Currently, only text boxes, pictures, and geometric shapes are supported. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105295,9 +105308,9 @@ declare namespace Word { */ untrack(): Word.Canvas; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.CanvasData; } /** @@ -105317,7 +105330,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param types Required. An array of geometric shape subtypes. + * @param types An array of geometric shape subtypes. */ getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; /** @@ -105326,7 +105339,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param id Required. A shape identifier. + * @param id A shape identifier. */ getById(id: number): Word.Shape; /** @@ -105335,7 +105348,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param id Required. A shape identifier. + * @param id A shape identifier. */ getByIdOrNullObject(id: number): Word.Shape; /** @@ -105344,7 +105357,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param ids Required. An array of shape identifiers. + * @param ids An array of shape identifiers. */ getByIds(ids: number[]): Word.ShapeCollection; /** @@ -105353,7 +105366,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param names Required. An array of shape names. + * @param names An array of shape names. */ getByNames(names: string[]): Word.ShapeCollection; /** @@ -105362,7 +105375,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.2] * - * @param types Required. An array of shape types. + * @param types An array of shape types. */ getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; /** @@ -105380,7 +105393,7 @@ declare namespace Word { */ getFirstOrNullObject(): Word.Shape; /** - * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes. + * Groups floating shapes in this collection, inline shapes will be skipped. Returns a `Shape` object that represents the new group of shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105413,13 +105426,13 @@ declare namespace Word { */ untrack(): Word.ShapeCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.ShapeCollectionData; } /** - * Represents the fill formatting of a shape object. + * Represents the fill formatting of a {@link Word.Shape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105464,14 +105477,14 @@ declare namespace Word { /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Word.ShapeFill): void; /** - * Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`; + * Clears the fill formatting of this shape and sets it to `Word.ShapeFillType.noFill`. * * @remarks * [Api set: WordApiDesktop 1.2] */ clear(): void; /** - * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`. + * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.solid`. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105509,13 +105522,13 @@ declare namespace Word { */ untrack(): Word.ShapeFill; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShapeFillData; } /** - * Represents the text frame of a shape object. + * Represents the text frame of a {@link Word.Shape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105524,63 +105537,63 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * 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 automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks * [Api set: WordApiDesktop 1.2] */ autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the bottom margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ bottomMargin: number; /** - * Specifies if the text frame contains text. + * Returns `true` if the text frame contains text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ readonly hasText: boolean; /** - * Represents the left margin, in points, of the text frame. + * Specifies the left margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ leftMargin: number; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. * * @remarks * [Api set: WordApiDesktop 1.2] */ noTextRotation: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks * [Api set: WordApiDesktop 1.2] */ orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Represents the right margin, in points, of the text frame. + * Specifies the right margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ rightMargin: number; /** - * Represents the top margin, in points, of the text frame. + * Specifies the top margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ topMargin: number; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105631,13 +105644,13 @@ declare namespace Word { */ untrack(): Word.TextFrame; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TextFrameData; } /** - * Represents all the properties for wrapping text around a shape. + * Represents all the properties for wrapping text around a {@link Word.Shape}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -105725,9 +105738,9 @@ declare namespace Word { */ untrack(): Word.ShapeTextWrap; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.ShapeTextWrapData; } /** @@ -105805,9 +105818,9 @@ declare namespace Word { */ untrack(): Word.RepeatingSectionItem; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.RepeatingSectionItemData; } /** @@ -105853,9 +105866,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; }; @@ -106016,7 +106029,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param deleteContents Optional. If true, deletes the contents as well. + * @param deleteContents Optional. If `true`, deletes the contents as well. */ delete(deleteContents?: boolean): void; /** @@ -106058,9 +106071,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; } /** @@ -106233,9 +106246,9 @@ declare namespace Word { */ untrack(): Word.PictureContentControl; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.PictureContentControlData; } /** @@ -106415,9 +106428,9 @@ declare namespace Word { */ untrack(): Word.GroupContentControl; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.GroupContentControlData; } /** @@ -106600,7 +106613,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param options The options for configuring the content control's placeholder text. + * @param options Optional. The options for configuring the content control's placeholder text. */ setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** @@ -106633,9 +106646,9 @@ declare namespace Word { */ untrack(): Word.BuildingBlockGalleryContentControl; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; } /** @@ -106822,9 +106835,9 @@ declare namespace Word { */ untrack(): Word.RepeatingSectionContentControl; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.RepeatingSectionContentControlData; } /** @@ -107107,9 +107120,9 @@ declare namespace Word { */ untrack(): Word.Frame; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.FrameData; } /** @@ -107176,9 +107189,9 @@ declare namespace Word { */ untrack(): Word.FrameCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.FrameCollectionData; } /** @@ -107241,9 +107254,9 @@ declare namespace Word { */ untrack(): Word.DocumentLibraryVersion; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.DocumentLibraryVersionData; } /** @@ -107300,9 +107313,9 @@ declare namespace Word { */ untrack(): Word.DocumentLibraryVersionCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; } /** @@ -107410,18 +107423,20 @@ declare namespace Word { formatted = "Formatted", } /** - * Note item type + * Note item type. * * @remarks * [Api set: WordApi 1.5] */ enum NoteItemType { /** + * Footnote type. * @remarks * [Api set: WordApi 1.5] */ footnote = "Footnote", /** + * Endnote type. * @remarks * [Api set: WordApi 1.5] */ @@ -107527,25 +107542,27 @@ declare namespace Word { */ enum EventSource { /** + * Local source. * @remarks * [Api set: WordApi 1.5] */ local = "Local", /** + * Remote source. * @remarks * [Api set: WordApi 1.5] */ remote = "Remote", } /** - * Provides information about the content control that raised contentControlAdded event. + * Provides information about the content control that raised the `contentControlAdded` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlAddedEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -107567,14 +107584,14 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the content control that raised contentControlDataChanged event. + * Provides information about the content control that raised the `contentControlDataChanged` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlDataChangedEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -107596,14 +107613,14 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the content control that raised contentControlDeleted event. + * Provides information about the content control that raised the `contentControlDeleted` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlDeletedEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -107625,14 +107642,14 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the content control that raised contentControlEntered event. + * Provides information about the content control that raised the `contentControlEntered` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlEnteredEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -107654,14 +107671,14 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the content control that raised contentControlExited event. + * Provides information about the content control that raised the `contentControlExited` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlExitedEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -107683,14 +107700,14 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the content control that raised contentControlSelectionChanged event. + * Provides information about the content control that raised the `contentControlSelectionChanged` event. * * @remarks * [Api set: WordApi 1.5] */ interface ContentControlSelectionChangedEventArgs { /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -107712,7 +107729,7 @@ declare namespace Word { source: Word.EventSource | "Local" | "Remote"; } /** - * Provides information about the paragraphs that raised the paragraphAdded event. + * Provides information about the paragraphs that raised the `paragraphAdded` event. * * @remarks * [Api set: WordApi 1.6] @@ -107726,7 +107743,7 @@ declare namespace Word { */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -107741,7 +107758,7 @@ declare namespace Word { uniqueLocalIds: string[]; } /** - * Provides information about the paragraphs that raised the paragraphChanged event. + * Provides information about the paragraphs that raised the `paragraphChanged` event. * * @remarks * [Api set: WordApi 1.6] @@ -107755,7 +107772,7 @@ declare namespace Word { */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -107770,7 +107787,7 @@ declare namespace Word { uniqueLocalIds: string[]; } /** - * Provides information about the paragraphs that raised the paragraphDeleted event. + * Provides information about the paragraphs that raised the `paragraphDeleted` event. * * @remarks * [Api set: WordApi 1.6] @@ -107784,7 +107801,7 @@ declare namespace Word { */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See Word.EventType for details. + * The event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -107806,107 +107823,119 @@ declare namespace Word { */ enum ContentControlType { /** + * Unknown content control type. * @remarks * [Api set: WordApi 1.1] */ unknown = "Unknown", /** + * Rich text content control subtype containing inline elements. * @remarks * [Api set: WordApi 1.1] */ richTextInline = "RichTextInline", /** + * Rich text content control subtype containing paragraphs. * @remarks * [Api set: WordApi 1.1] */ richTextParagraphs = "RichTextParagraphs", /** - * Contains a whole cell. + * Rich text content control subtype containing a whole cell. * @remarks * [Api set: WordApi 1.1] */ richTextTableCell = "RichTextTableCell", /** - * Contains a whole row. + * Rich text content control subtype containing a whole row. * @remarks * [Api set: WordApi 1.1] */ richTextTableRow = "RichTextTableRow", /** - * Contains a whole table. + * Rich text content control subtype containing a whole table. * @remarks * [Api set: WordApi 1.1] */ richTextTable = "RichTextTable", /** + * Plain text content control subtype containing inline elements. * @remarks * [Api set: WordApi 1.1] */ plainTextInline = "PlainTextInline", /** + * Plain text content control subtype containing paragraphs. * @remarks * [Api set: WordApi 1.1] */ plainTextParagraph = "PlainTextParagraph", /** + * Picture content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ picture = "Picture", /** + * Building block gallery content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ buildingBlockGallery = "BuildingBlockGallery", /** + * Check box content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ checkBox = "CheckBox", /** + * Combo box content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ comboBox = "ComboBox", /** + * Dropdown list content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ dropDownList = "DropDownList", /** + * Date picker content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ datePicker = "DatePicker", /** + * Repeating section content control (type and subtype). * @remarks * [Api set: WordApi 1.1] */ repeatingSection = "RepeatingSection", /** - * Identifies a rich text content control. + * Rich text content control type. * @remarks * [Api set: WordApi 1.1] */ richText = "RichText", /** + * Plain text content control type. * @remarks * [Api set: WordApi 1.1] */ plainText = "PlainText", /** + * Group content control type. * @remarks * [Api set: WordApi 1.1] */ group = "Group", } /** - * ContentControl appearance. + * Represents the content control appearance. * * @remarks * [Api set: WordApi 1.1] - * - * Content control appearance options are BoundingBox, Tags, or Hidden. */ enum ContentControlAppearance { /** @@ -107929,7 +107958,7 @@ declare namespace Word { hidden = "Hidden", } /** - * Content control level types. + * Represents the content control level type. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -107961,7 +107990,7 @@ declare namespace Word { cell = "Cell", } /** - * The supported styles for underline format. + * Represents the supported styles for underline format. * * @remarks * [Api set: WordApi 1.1] @@ -108023,6 +108052,7 @@ declare namespace Word { */ dotted = "Dotted", /** + * A heavy dotted underline. * @remarks * [Api set: WordApi 1.1] */ @@ -108034,16 +108064,19 @@ declare namespace Word { */ dashLine = "DashLine", /** + * A heavy dash underline. * @remarks * [Api set: WordApi 1.1] */ dashLineHeavy = "DashLineHeavy", /** + * A long dash underline. * @remarks * [Api set: WordApi 1.1] */ dashLineLong = "DashLineLong", /** + * A long heavy dash underline. * @remarks * [Api set: WordApi 1.1] */ @@ -108055,6 +108088,7 @@ declare namespace Word { */ dotDashLine = "DotDashLine", /** + * A heavy dot-dash underline. * @remarks * [Api set: WordApi 1.1] */ @@ -108066,6 +108100,7 @@ declare namespace Word { */ twoDotDashLine = "TwoDotDashLine", /** + * An alternating heavy dot-dot-dash underline. * @remarks * [Api set: WordApi 1.1] */ @@ -108077,11 +108112,13 @@ declare namespace Word { */ wave = "Wave", /** + * A heavy wavy underline. * @remarks * [Api set: WordApi 1.1] */ waveHeavy = "WaveHeavy", /** + * A double wavy underline. * @remarks * [Api set: WordApi 1.1] */ @@ -108139,14 +108176,14 @@ declare namespace Word { line = "Line", } /** - * The insertion location types. + * Represents the insertion location type. * * @remarks * [Api set: WordApi 1.1] * * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. - * If the location is "Before" or "After", the new content will be outside of the modified object. - * If the location is "Start" or "End", the new content will be included as part of the modified object. + * If the location is `before` or `after`, the new content will be outside of the modified object. + * If the location is `start` or `end`, the new content will be included as part of the modified object. */ enum InsertLocation { /** @@ -108181,11 +108218,14 @@ declare namespace Word { replace = "Replace", } /** + * Represents the horizontal alignment of text. + * * @remarks * [Api set: WordApi 1.1] */ enum Alignment { /** + * Mixed horizontal alignment. * @remarks * [Api set: WordApi 1.1] */ @@ -108222,6 +108262,8 @@ declare namespace Word { justified = "Justified", } /** + * Represents the type of header or footer. + * * @remarks * [Api set: WordApi 1.1] */ @@ -108246,7 +108288,7 @@ declare namespace Word { evenPages = "EvenPages", } /** - * Represents the types of body objects. + * Represents the types of `Body` objects. * * @remarks * [Api set: WordApi 1.3] @@ -108308,7 +108350,7 @@ declare namespace Word { noteItem = "NoteItem", } /** - * This enum sets where the cursor (insertion point) in the document is after a selection. + * Represents where the cursor (insertion point) is set in the document after a selection. * * @remarks * [Api set: WordApi 1.1] @@ -108334,76 +108376,92 @@ declare namespace Word { end = "End", } /** + * Represents image format type. + * * @remarks * [Api set: WordApiDesktop 1.1] */ enum ImageFormat { /** + * Unsupported image format. * @remarks * [Api set: WordApiDesktop 1.1] */ unsupported = "Unsupported", /** + * Undefined image format. * @remarks * [Api set: WordApiDesktop 1.1] */ undefined = "Undefined", /** + * Bitmap image format. * @remarks * [Api set: WordApiDesktop 1.1] */ bmp = "Bmp", /** + * JPEG image format. * @remarks * [Api set: WordApiDesktop 1.1] */ jpeg = "Jpeg", /** + * GIF image format. * @remarks * [Api set: WordApiDesktop 1.1] */ gif = "Gif", /** + * TIFF image format. * @remarks * [Api set: WordApiDesktop 1.1] */ tiff = "Tiff", /** + * PNG image format. * @remarks * [Api set: WordApiDesktop 1.1] */ png = "Png", /** + * Icon image format. * @remarks * [Api set: WordApiDesktop 1.1] */ icon = "Icon", /** + * Exif image format. * @remarks * [Api set: WordApiDesktop 1.1] */ exif = "Exif", /** + * Windows Metafile image format. * @remarks * [Api set: WordApiDesktop 1.1] */ wmf = "Wmf", /** + * Enhanced Metafile image format. * @remarks * [Api set: WordApiDesktop 1.1] */ emf = "Emf", /** + * PICT image format. * @remarks * [Api set: WordApiDesktop 1.1] */ pict = "Pict", /** + * PDF image format. * @remarks * [Api set: WordApiDesktop 1.1] */ pdf = "Pdf", /** + * SVG image format. * @remarks * [Api set: WordApiDesktop 1.1] */ @@ -108447,19 +108505,21 @@ declare namespace Word { */ after = "After", /** - * The range between 'Start' and 'End'. + * The range between `start` and `end`. * @remarks * [Api set: WordApi 1.3] */ content = "Content", } /** + * Represents the relationship of the location of this instance to another range. + * * @remarks * [Api set: WordApi 1.3] */ enum LocationRelation { /** - * Indicates that this instance and the range are in different sub-documents. + * Indicates that this instance and the range are in different subdocuments. * @remarks * [Api set: WordApi 1.3] */ @@ -108544,77 +108604,94 @@ declare namespace Word { after = "After", } /** + * Represents the location of a {@link Word.Border | border}. + * * @remarks * [Api set: WordApi 1.3] */ enum BorderLocation { /** + * Top border. * @remarks * [Api set: WordApi 1.3] */ top = "Top", /** + * Left border. * @remarks * [Api set: WordApi 1.3] */ left = "Left", /** + * Bottom border. * @remarks * [Api set: WordApi 1.3] */ bottom = "Bottom", /** + * Right border. * @remarks * [Api set: WordApi 1.3] */ right = "Right", /** + * Inside horizontal border. * @remarks * [Api set: WordApi 1.3] */ insideHorizontal = "InsideHorizontal", /** + * Inside vertical border. * @remarks * [Api set: WordApi 1.3] */ insideVertical = "InsideVertical", /** + * Inside border. * @remarks * [Api set: WordApi 1.3] */ inside = "Inside", /** + * Outside border. * @remarks * [Api set: WordApi 1.3] */ outside = "Outside", /** + * All borders. * @remarks * [Api set: WordApi 1.3] */ all = "All", } /** + * Represents the location of cell padding. + * * @remarks * [Api set: WordApi 1.3] */ enum CellPaddingLocation { /** + * Padding at the top of the cell. * @remarks * [Api set: WordApi 1.3] */ top = "Top", /** + * Padding at the left of the cell. * @remarks * [Api set: WordApi 1.3] */ left = "Left", /** + * Padding at the bottom of the cell. * @remarks * [Api set: WordApi 1.3] */ bottom = "Bottom", /** + * Padding at the right of the cell. * @remarks * [Api set: WordApi 1.3] */ @@ -108695,250 +108772,304 @@ declare namespace Word { mixed = "Mixed", } /** + * The {@link Word.Border | border} types. + * * @remarks * [Api set: WordApi 1.3] */ enum BorderType { /** + * Mixed border type. * @remarks * [Api set: WordApi 1.3] */ mixed = "Mixed", /** + * No border. * @remarks * [Api set: WordApi 1.3] */ none = "None", /** + * Single border. * @remarks * [Api set: WordApi 1.3] */ single = "Single", /** + * Double border. * @remarks * [Api set: WordApi 1.3] */ double = "Double", /** + * Dotted border. * @remarks * [Api set: WordApi 1.3] */ dotted = "Dotted", /** + * Dashed border. * @remarks * [Api set: WordApi 1.3] */ dashed = "Dashed", /** + * Dot-dashed border. * @remarks * [Api set: WordApi 1.3] */ dotDashed = "DotDashed", /** + * Double dot-dashed border. * @remarks * [Api set: WordApi 1.3] */ dot2Dashed = "Dot2Dashed", /** + * Triple border. * @remarks * [Api set: WordApi 1.3] */ triple = "Triple", /** + * Thin-thick small border. * @remarks * [Api set: WordApi 1.3] */ thinThickSmall = "ThinThickSmall", /** + * Thick-thin small border. * @remarks * [Api set: WordApi 1.3] */ thickThinSmall = "ThickThinSmall", /** + * Thin-thick-thin small border. * @remarks * [Api set: WordApi 1.3] */ thinThickThinSmall = "ThinThickThinSmall", /** + * Thin-thick medium border. * @remarks * [Api set: WordApi 1.3] */ thinThickMed = "ThinThickMed", /** + * Thick-thin medium border. * @remarks * [Api set: WordApi 1.3] */ thickThinMed = "ThickThinMed", /** + * Thin-thick-thin medium border. * @remarks * [Api set: WordApi 1.3] */ thinThickThinMed = "ThinThickThinMed", /** + * Thin-thick large border. * @remarks * [Api set: WordApi 1.3] */ thinThickLarge = "ThinThickLarge", /** + * Thick-thin large border. * @remarks * [Api set: WordApi 1.3] */ thickThinLarge = "ThickThinLarge", /** + * Thin-thick-thin large border. * @remarks * [Api set: WordApi 1.3] */ thinThickThinLarge = "ThinThickThinLarge", /** + * Wave border. * @remarks * [Api set: WordApi 1.3] */ wave = "Wave", /** + * Double wave border. * @remarks * [Api set: WordApi 1.3] */ doubleWave = "DoubleWave", /** + * Dashed small border. * @remarks * [Api set: WordApi 1.3] */ dashedSmall = "DashedSmall", /** + * Dash-dot-stroked border. * @remarks * [Api set: WordApi 1.3] */ dashDotStroked = "DashDotStroked", /** + * 3D Emboss border. * @remarks * [Api set: WordApi 1.3] */ threeDEmboss = "ThreeDEmboss", /** + * 3D Engrave border. * @remarks * [Api set: WordApi 1.3] */ threeDEngrave = "ThreeDEngrave", } /** + * Represents the vertical alignment of text. + * * @remarks * [Api set: WordApi 1.3] */ enum VerticalAlignment { /** + * Mixed vertical alignment. * @remarks * [Api set: WordApi 1.3] */ mixed = "Mixed", /** + * Top vertical alignment. * @remarks * [Api set: WordApi 1.3] */ top = "Top", /** + * Center vertical alignment. * @remarks * [Api set: WordApi 1.3] */ center = "Center", /** + * Bottom vertical alignment. * @remarks * [Api set: WordApi 1.3] */ bottom = "Bottom", } /** + * Represents the type of list level. + * * @remarks * [Api set: WordApi 1.3] */ enum ListLevelType { /** + * Represents the bullet type. * @remarks * [Api set: WordApi 1.3] */ bullet = "Bullet", /** + * Represents the numbering type. * @remarks * [Api set: WordApi 1.3] */ number = "Number", /** + * Represents the picture type. * @remarks * [Api set: WordApi 1.3] */ picture = "Picture", } /** + * Represents the bullet style in a list. + * * @remarks * [Api set: WordApi 1.3] */ enum ListBullet { /** + * Represents custom bullet. * @remarks * [Api set: WordApi 1.3] */ custom = "Custom", /** + * Represents solid bullet. * @remarks * [Api set: WordApi 1.3] */ solid = "Solid", /** + * Represents hollow bullet. * @remarks * [Api set: WordApi 1.3] */ hollow = "Hollow", /** + * Represents square bullet. * @remarks * [Api set: WordApi 1.3] */ square = "Square", /** + * Represents diamond bullet. * @remarks * [Api set: WordApi 1.3] */ diamonds = "Diamonds", /** + * Represents arrow bullet. * @remarks * [Api set: WordApi 1.3] */ arrow = "Arrow", /** + * Represents checkmark bullet. * @remarks * [Api set: WordApi 1.3] */ checkmark = "Checkmark", } /** + * Represents the numbering style in a list. + * * @remarks * [Api set: WordApi 1.3] */ enum ListNumbering { /** + * Represents no numbering. * @remarks * [Api set: WordApi 1.3] */ none = "None", /** + * Represents Arabic numbering. * @remarks * [Api set: WordApi 1.3] */ arabic = "Arabic", /** + * Represents upper Roman numeral numbering. * @remarks * [Api set: WordApi 1.3] */ upperRoman = "UpperRoman", /** + * Represents lower Roman numeral numbering. * @remarks * [Api set: WordApi 1.3] */ lowerRoman = "LowerRoman", /** + * Represents upper letter numbering. * @remarks * [Api set: WordApi 1.3] */ upperLetter = "UpperLetter", /** + * Represents lower letter numbering. * @remarks * [Api set: WordApi 1.3] */ @@ -108966,46 +109097,55 @@ declare namespace Word { */ normal = "Normal", /** + * Heading 1 style. * @remarks * [Api set: WordApi 1.3] */ heading1 = "Heading1", /** + * Heading 2 style. * @remarks * [Api set: WordApi 1.3] */ heading2 = "Heading2", /** + * Heading 3 style. * @remarks * [Api set: WordApi 1.3] */ heading3 = "Heading3", /** + * Heading 4 style. * @remarks * [Api set: WordApi 1.3] */ heading4 = "Heading4", /** + * Heading 5 style. * @remarks * [Api set: WordApi 1.3] */ heading5 = "Heading5", /** + * Heading 6 style. * @remarks * [Api set: WordApi 1.3] */ heading6 = "Heading6", /** + * Heading 7 style. * @remarks * [Api set: WordApi 1.3] */ heading7 = "Heading7", /** + * Heading 8 style. * @remarks * [Api set: WordApi 1.3] */ heading8 = "Heading8", /** + * Heading 9 style. * @remarks * [Api set: WordApi 1.3] */ @@ -109065,111 +109205,133 @@ declare namespace Word { */ toc9 = "Toc9", /** + * Footnote text style. * @remarks * [Api set: WordApi 1.3] */ footnoteText = "FootnoteText", /** + * Header style. * @remarks * [Api set: WordApi 1.3] */ header = "Header", /** + * Footer style. * @remarks * [Api set: WordApi 1.3] */ footer = "Footer", /** + * Caption style. * @remarks * [Api set: WordApi 1.3] */ caption = "Caption", /** + * Footnote reference style. * @remarks * [Api set: WordApi 1.3] */ footnoteReference = "FootnoteReference", /** + * Endnote reference style. * @remarks * [Api set: WordApi 1.3] */ endnoteReference = "EndnoteReference", /** + * Endnote text style. * @remarks * [Api set: WordApi 1.3] */ endnoteText = "EndnoteText", /** + * Title style. * @remarks * [Api set: WordApi 1.3] */ title = "Title", /** + * Subtitle style. * @remarks * [Api set: WordApi 1.3] */ subtitle = "Subtitle", /** + * Hyperlink style. * @remarks * [Api set: WordApi 1.3] */ hyperlink = "Hyperlink", /** + * Strong style. * @remarks * [Api set: WordApi 1.3] */ strong = "Strong", /** + * Emphasis style. * @remarks * [Api set: WordApi 1.3] */ emphasis = "Emphasis", /** + * No spacing style. * @remarks * [Api set: WordApi 1.3] */ noSpacing = "NoSpacing", /** + * List paragraph style. * @remarks * [Api set: WordApi 1.3] */ listParagraph = "ListParagraph", /** + * Quote style. * @remarks * [Api set: WordApi 1.3] */ quote = "Quote", /** + * Intense quote style. * @remarks * [Api set: WordApi 1.3] */ intenseQuote = "IntenseQuote", /** + * Subtle emphasis style. * @remarks * [Api set: WordApi 1.3] */ subtleEmphasis = "SubtleEmphasis", /** + * Intense emphasis style. * @remarks * [Api set: WordApi 1.3] */ intenseEmphasis = "IntenseEmphasis", /** + * Subtle reference style. * @remarks * [Api set: WordApi 1.3] */ subtleReference = "SubtleReference", /** + * Intense reference style. * @remarks * [Api set: WordApi 1.3] */ intenseReference = "IntenseReference", /** + * Book title style. * @remarks * [Api set: WordApi 1.3] */ bookTitle = "BookTitle", /** + * Bibliography style. * @remarks * [Api set: WordApi 1.3] */ @@ -109181,552 +109343,663 @@ declare namespace Word { */ tocHeading = "TocHeading", /** + * Table grid style. * @remarks * [Api set: WordApi 1.3] */ tableGrid = "TableGrid", /** + * Plain table style 1. * @remarks * [Api set: WordApi 1.3] */ plainTable1 = "PlainTable1", /** + * Plain table style 2. * @remarks * [Api set: WordApi 1.3] */ plainTable2 = "PlainTable2", /** + * Plain table style 3. * @remarks * [Api set: WordApi 1.3] */ plainTable3 = "PlainTable3", /** + * Plain table style 4. * @remarks * [Api set: WordApi 1.3] */ plainTable4 = "PlainTable4", /** + * Plain table style 5. * @remarks * [Api set: WordApi 1.3] */ plainTable5 = "PlainTable5", /** + * Table grid light style. * @remarks * [Api set: WordApi 1.3] */ tableGridLight = "TableGridLight", /** + * Grid table light style 1. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light = "GridTable1Light", /** + * Grid table light style 1, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent1 = "GridTable1Light_Accent1", /** + * Grid table light style 1, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent2 = "GridTable1Light_Accent2", /** + * Grid table light style 1, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent3 = "GridTable1Light_Accent3", /** + * Grid table light style 1, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent4 = "GridTable1Light_Accent4", /** + * Grid table light style 1, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent5 = "GridTable1Light_Accent5", /** + * Grid table light style 1, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable1Light_Accent6 = "GridTable1Light_Accent6", /** + * Grid table style 2. * @remarks * [Api set: WordApi 1.3] */ gridTable2 = "GridTable2", /** + * Grid table style 2, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent1 = "GridTable2_Accent1", /** + * Grid table style 2, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent2 = "GridTable2_Accent2", /** + * Grid table style 2, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent3 = "GridTable2_Accent3", /** + * Grid table style 2, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent4 = "GridTable2_Accent4", /** + * Grid table style 2, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent5 = "GridTable2_Accent5", /** + * Grid table style 2, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable2_Accent6 = "GridTable2_Accent6", /** + * Grid table style 3. * @remarks * [Api set: WordApi 1.3] */ gridTable3 = "GridTable3", /** + * Grid table style 3, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent1 = "GridTable3_Accent1", /** + * Grid table style 3, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent2 = "GridTable3_Accent2", /** + * Grid table style 3, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent3 = "GridTable3_Accent3", /** + * Grid table style 3, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent4 = "GridTable3_Accent4", /** + * Grid table style 3, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent5 = "GridTable3_Accent5", /** + * Grid table style 3, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable3_Accent6 = "GridTable3_Accent6", /** + * Grid table style 4. * @remarks * [Api set: WordApi 1.3] */ gridTable4 = "GridTable4", /** + * Grid table style 4, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent1 = "GridTable4_Accent1", /** + * Grid table style 4, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent2 = "GridTable4_Accent2", /** + * Grid table style 4, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent3 = "GridTable4_Accent3", /** + * Grid table style 4, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent4 = "GridTable4_Accent4", /** + * Grid table style 4, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent5 = "GridTable4_Accent5", /** + * Grid table style 4, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable4_Accent6 = "GridTable4_Accent6", /** + * Grid table dark style 5. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark = "GridTable5Dark", /** + * Grid table dark style 5, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", /** + * Grid table dark style 5, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", /** + * Grid table dark style 5, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", /** + * Grid table dark style 5, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", /** + * Grid table dark style 5, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", /** + * Grid table dark style 5, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", /** + * Grid table colorful style 6. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful = "GridTable6Colorful", /** + * Grid table colorful style 6, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", /** + * Grid table colorful style 6, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", /** + * Grid table colorful style 6, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", /** + * Grid table colorful style 6, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", /** + * Grid table colorful style 6, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", /** + * Grid table colorful style 6, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", /** + * Grid table colorful style 7. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful = "GridTable7Colorful", /** + * Grid table colorful style 7, accent 1. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", /** + * Grid table colorful style 7, accent 2. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", /** + * Grid table colorful style 7, accent 3. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", /** + * Grid table colorful style 7, accent 4. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", /** + * Grid table colorful style 7, accent 5. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", /** + * Grid table colorful style 7, accent 6. * @remarks * [Api set: WordApi 1.3] */ gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", /** + * List table light style 1. * @remarks * [Api set: WordApi 1.3] */ listTable1Light = "ListTable1Light", /** + * List table light style 1, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent1 = "ListTable1Light_Accent1", /** + * List table light style 1, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent2 = "ListTable1Light_Accent2", /** + * List table light style 1, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent3 = "ListTable1Light_Accent3", /** + * List table light style 1, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent4 = "ListTable1Light_Accent4", /** + * List table light style 1, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent5 = "ListTable1Light_Accent5", /** + * List table light style 1, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable1Light_Accent6 = "ListTable1Light_Accent6", /** + * List table style 2. * @remarks * [Api set: WordApi 1.3] */ listTable2 = "ListTable2", /** + * List table style 2, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent1 = "ListTable2_Accent1", /** + * List table style 2, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent2 = "ListTable2_Accent2", /** + * List table style 2, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent3 = "ListTable2_Accent3", /** + * List table style 2, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent4 = "ListTable2_Accent4", /** + * List table style 2, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent5 = "ListTable2_Accent5", /** + * List table style 2, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable2_Accent6 = "ListTable2_Accent6", /** + * List table style 3. * @remarks * [Api set: WordApi 1.3] */ listTable3 = "ListTable3", /** + * List table style 3, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent1 = "ListTable3_Accent1", /** + * List table style 3, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent2 = "ListTable3_Accent2", /** + * List table style 3, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent3 = "ListTable3_Accent3", /** + * List table style 3, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent4 = "ListTable3_Accent4", /** + * List table style 3, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent5 = "ListTable3_Accent5", /** + * List table style 3, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable3_Accent6 = "ListTable3_Accent6", /** + * List table style 4. * @remarks * [Api set: WordApi 1.3] */ listTable4 = "ListTable4", /** + * List table style 4, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent1 = "ListTable4_Accent1", /** + * List table style 4, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent2 = "ListTable4_Accent2", /** + * List table style 4, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent3 = "ListTable4_Accent3", /** + * List table style 4, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent4 = "ListTable4_Accent4", /** + * List table style 4, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent5 = "ListTable4_Accent5", /** + * List table style 4, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable4_Accent6 = "ListTable4_Accent6", /** + * List table dark style 5. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark = "ListTable5Dark", /** + * List table dark style 5, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent1 = "ListTable5Dark_Accent1", /** + * List table dark style 5, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent2 = "ListTable5Dark_Accent2", /** + * List table dark style 5, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent3 = "ListTable5Dark_Accent3", /** + * List table dark style 5, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent4 = "ListTable5Dark_Accent4", /** + * List table dark style 5, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent5 = "ListTable5Dark_Accent5", /** + * List table dark style 5, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable5Dark_Accent6 = "ListTable5Dark_Accent6", /** + * List table colorful style 6. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful = "ListTable6Colorful", /** + * List table colorful style 6, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", /** + * List table colorful style 6, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", /** + * List table colorful style 6, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", /** + * List table colorful style 6, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", /** + * List table colorful style 6, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", /** + * List table colorful style 6, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", /** + * List table colorful style 7. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful = "ListTable7Colorful", /** + * List table colorful style 7, accent 1. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", /** + * List table colorful style 7, accent 2. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", /** + * List table colorful style 7, accent 3. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", /** + * List table colorful style 7, accent 4. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", /** + * List table colorful style 7, accent 5. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", /** + * List table colorful style 7, accent 6. * @remarks * [Api set: WordApi 1.3] */ listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", } /** + * Represents the document property type. + * * @remarks * [Api set: WordApi 1.3] */ enum DocumentPropertyType { /** + * Represents a string type. * @remarks * [Api set: WordApi 1.3] */ string = "String", /** + * Represents a number type. * @remarks * [Api set: WordApi 1.3] */ number = "Number", /** + * Represents a date type. * @remarks * [Api set: WordApi 1.3] */ date = "Date", /** + * Represents a Boolean type. * @remarks * [Api set: WordApi 1.3] */ @@ -109875,7 +110148,7 @@ declare namespace Word { prompt = "Prompt", } /** - * Represents the type of Field. + * Represents the type of {@link Word.Field} object. * * @remarks * [Api set: WordApi 1.5] @@ -110423,7 +110696,7 @@ declare namespace Word { undefined = "Undefined", } /** - * Represents the kind of field. Indicates how the field works in relation to updating. + * Represents the kind of {@link Word.Field} object. Indicates how the field works in relation to updating. * * @remarks * [Api set: WordApi 1.5] @@ -110455,7 +110728,7 @@ declare namespace Word { cold = "Cold", } /** - * Represents the character inserted after the list item mark. + * Represents the character inserted after the {@link Word.ListItem | list item} mark. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -110481,346 +110754,416 @@ declare namespace Word { trailingNone = "TrailingNone", } /** + * Represents the built-in number styles for lists in Word. + * * @remarks * [Api set: WordApiDesktop 1.1] */ enum ListBuiltInNumberStyle { /** + * No built-in number style. * @remarks * [Api set: WordApiDesktop 1.1] */ none = "None", /** + * Arabic numerals (1, 2, 3, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ arabic = "Arabic", /** + * Uppercase Roman numerals (I, II, III, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ upperRoman = "UpperRoman", /** + * Lowercase Roman numerals (i, ii, iii, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ lowerRoman = "LowerRoman", /** + * Uppercase letters (A, B, C, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ upperLetter = "UpperLetter", /** + * Lowercase letters (a, b, c, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ lowerLetter = "LowerLetter", /** + * Ordinal numbers (1st, 2nd, 3rd, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ ordinal = "Ordinal", /** + * Cardinal numbers as text (one, two, three, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ cardinalText = "CardinalText", /** + * Ordinal numbers as text (first, second, third, ...). * @remarks * [Api set: WordApiDesktop 1.1] */ ordinalText = "OrdinalText", /** + * Kanji. * @remarks * [Api set: WordApiDesktop 1.1] */ kanji = "Kanji", /** + * Kanji digits. * @remarks * [Api set: WordApiDesktop 1.1] */ kanjiDigit = "KanjiDigit", /** + * Aiueo half width characters. * @remarks * [Api set: WordApiDesktop 1.1] */ aiueoHalfWidth = "AiueoHalfWidth", /** + * Iroha half width characters. * @remarks * [Api set: WordApiDesktop 1.1] */ irohaHalfWidth = "IrohaHalfWidth", /** + * Arabic full-width numbers. * @remarks * [Api set: WordApiDesktop 1.1] */ arabicFullWidth = "ArabicFullWidth", /** + * Traditional Kanji characters. * @remarks * [Api set: WordApiDesktop 1.1] */ kanjiTraditional = "KanjiTraditional", /** + * Traditional Kanji characters (alternative form). * @remarks * [Api set: WordApiDesktop 1.1] */ kanjiTraditional2 = "KanjiTraditional2", /** + * Numbers enclosed in a circle. * @remarks * [Api set: WordApiDesktop 1.1] */ numberInCircle = "NumberInCircle", /** + * Aiueo characters. * @remarks * [Api set: WordApiDesktop 1.1] */ aiueo = "Aiueo", /** + * Iroha characters. * @remarks * [Api set: WordApiDesktop 1.1] */ iroha = "Iroha", /** + * Arabic full-width numbers with leading zeros. * @remarks * [Api set: WordApiDesktop 1.1] */ arabicLZ = "ArabicLZ", /** + * Bullet characters. * @remarks * [Api set: WordApiDesktop 1.1] */ bullet = "Bullet", /** + * Ganada characters. * @remarks * [Api set: WordApiDesktop 1.1] */ ganada = "Ganada", /** + * Chosung characters. * @remarks * [Api set: WordApiDesktop 1.1] */ chosung = "Chosung", /** + * GBNum1 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ gbnum1 = "GBNum1", /** + * GBNum2 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ gbnum2 = "GBNum2", /** + * GBNum3 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ gbnum3 = "GBNum3", /** + * GBNum4 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ gbnum4 = "GBNum4", /** + * Zodiac1 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ zodiac1 = "Zodiac1", /** + * Zodiac2 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ zodiac2 = "Zodiac2", /** + * Zodiac3 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ zodiac3 = "Zodiac3", /** + * Traditional Chinese numbers (style 1). * @remarks * [Api set: WordApiDesktop 1.1] */ tradChinNum1 = "TradChinNum1", /** + * Traditional Chinese numbers (style 2). * @remarks * [Api set: WordApiDesktop 1.1] */ tradChinNum2 = "TradChinNum2", /** + * Traditional Chinese numbers (style 3). * @remarks * [Api set: WordApiDesktop 1.1] */ tradChinNum3 = "TradChinNum3", /** + * Traditional Chinese numbers (style 4). * @remarks * [Api set: WordApiDesktop 1.1] */ tradChinNum4 = "TradChinNum4", /** + * Simplified Chinese numbers (style 1). * @remarks * [Api set: WordApiDesktop 1.1] */ simpChinNum1 = "SimpChinNum1", /** + * Simplified Chinese numbers (style 2). * @remarks * [Api set: WordApiDesktop 1.1] */ simpChinNum2 = "SimpChinNum2", /** + * Simplified Chinese numbers (style 3). * @remarks * [Api set: WordApiDesktop 1.1] */ simpChinNum3 = "SimpChinNum3", /** + * Simplified Chinese numbers (style 4). * @remarks * [Api set: WordApiDesktop 1.1] */ simpChinNum4 = "SimpChinNum4", /** + * Hanja read numbers. * @remarks * [Api set: WordApiDesktop 1.1] */ hanjaRead = "HanjaRead", /** + * Hanja read digits. * @remarks * [Api set: WordApiDesktop 1.1] */ hanjaReadDigit = "HanjaReadDigit", /** + * Hangul characters. * @remarks * [Api set: WordApiDesktop 1.1] */ hangul = "Hangul", /** + * Hanja characters. * @remarks * [Api set: WordApiDesktop 1.1] */ hanja = "Hanja", /** + * Hebrew1 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ hebrew1 = "Hebrew1", /** + * Arabic1 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ arabic1 = "Arabic1", /** + * Hebrew2 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ hebrew2 = "Hebrew2", /** + * Arabic2 characters. * @remarks * [Api set: WordApiDesktop 1.1] */ arabic2 = "Arabic2", /** + * Hindi letter style 1. * @remarks * [Api set: WordApiDesktop 1.1] */ hindiLetter1 = "HindiLetter1", /** + * Hindi letter style 2. * @remarks * [Api set: WordApiDesktop 1.1] */ hindiLetter2 = "HindiLetter2", /** + * Hindi Arabic style. * @remarks * [Api set: WordApiDesktop 1.1] */ hindiArabic = "HindiArabic", /** + * Hindi cardinal text. * @remarks * [Api set: WordApiDesktop 1.1] */ hindiCardinalText = "HindiCardinalText", /** + * Thai letter characters. * @remarks * [Api set: WordApiDesktop 1.1] */ thaiLetter = "ThaiLetter", /** + * Thai Arabic characters. * @remarks * [Api set: WordApiDesktop 1.1] */ thaiArabic = "ThaiArabic", /** + * Thai cardinal text. * @remarks * [Api set: WordApiDesktop 1.1] */ thaiCardinalText = "ThaiCardinalText", /** + * Vietnamese cardinal text. * @remarks * [Api set: WordApiDesktop 1.1] */ vietCardinalText = "VietCardinalText", /** + * Lowercase Russian. * @remarks * [Api set: WordApiDesktop 1.1] */ lowercaseRussian = "LowercaseRussian", /** + * Uppercase Russian. * @remarks * [Api set: WordApiDesktop 1.1] */ uppercaseRussian = "UppercaseRussian", /** + * Lowercase Greek. * @remarks * [Api set: WordApiDesktop 1.1] */ lowercaseGreek = "LowercaseGreek", /** + * Uppercase Greek. * @remarks * [Api set: WordApiDesktop 1.1] */ uppercaseGreek = "UppercaseGreek", /** + * Arabic numbers with leading zeros (style 2). * @remarks * [Api set: WordApiDesktop 1.1] */ arabicLZ2 = "ArabicLZ2", /** + * Arabic numbers with leading zeros (style 3). * @remarks * [Api set: WordApiDesktop 1.1] */ arabicLZ3 = "ArabicLZ3", /** + * Arabic numbers with leading zeros (style 4). * @remarks * [Api set: WordApiDesktop 1.1] */ arabicLZ4 = "ArabicLZ4", /** + * Lowercase Turkish. * @remarks * [Api set: WordApiDesktop 1.1] */ lowercaseTurkish = "LowercaseTurkish", /** + * Uppercase Turkish. * @remarks * [Api set: WordApiDesktop 1.1] */ uppercaseTurkish = "UppercaseTurkish", /** + * Lowercase Bulgarian. * @remarks * [Api set: WordApiDesktop 1.1] */ lowercaseBulgarian = "LowercaseBulgarian", /** + * Uppercase Bulgarian. * @remarks * [Api set: WordApiDesktop 1.1] */ uppercaseBulgarian = "UppercaseBulgarian", /** + * Picture bullet. * @remarks * [Api set: WordApiDesktop 1.1] */ pictureBullet = "PictureBullet", /** + * Legal numbering style. * @remarks * [Api set: WordApiDesktop 1.1] */ legal = "Legal", /** + * Legal numbering style with leading zeros. * @remarks * [Api set: WordApiDesktop 1.1] */ @@ -111312,7 +111655,7 @@ declare namespace Word { outsideMargin = "OutsideMargin", } /** - * Specifies the shape type for a `GeometricShape` object. + * Specifies the shape type for a {@link Word.GeometricShape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -112382,7 +112725,7 @@ declare namespace Word { chartPlus = "ChartPlus", } /** - * Specifies a shape's fill type. + * Specifies a {@link Word.Shape | shape's} fill type. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -112700,7 +113043,7 @@ declare namespace Word { exact = "Exact", } /** - * Specifies the border style for an object. + * Specifies the {@link Word.BorderUniversal | border } style for an object. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -112858,7 +113201,7 @@ declare namespace Word { inset = "Inset", } /** - * Specifies the width of an object's border. + * Specifies the width of an object's {@link Word.BorderUniversal | border}. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -115684,7 +116027,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. + * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `word97`. */ applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** @@ -115693,7 +116036,7 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.3] * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. + * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `word97`. */ applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** @@ -115842,9 +116185,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; } /** @@ -115862,7 +116205,7 @@ declare namespace Word { */ level?: number; /** - * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. + * If provided, specifies the type of number to count. The default value is `paragraph`. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -115884,7 +116227,7 @@ declare namespace Word { */ applyLevel?: number; /** - * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. + * If provided, specifies which part of the list to apply the template to. The default value is `wholeList`. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -115898,7 +116241,7 @@ declare namespace Word { */ continuePreviousList?: boolean; /** - * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. + * If provided, specifies the default list behavior. The default value is `word97`. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -116196,9 +116539,9 @@ declare namespace Word { */ untrack(): Word.FillFormat; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.FillFormatData; } /** @@ -116269,9 +116612,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; } /** @@ -116427,9 +116770,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; } /** @@ -116514,9 +116857,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; } /** @@ -116601,9 +116944,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; } /** @@ -116749,9 +117092,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; } /** @@ -117089,9 +117432,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; } /** @@ -120523,9 +120866,9 @@ declare namespace Word { */ untrack(): Word.Bibliography; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.BibliographyData; } /** @@ -120576,9 +120919,9 @@ declare namespace Word { */ untrack(): Word.SourceCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.SourceCollectionData; } /** @@ -120657,9 +121000,9 @@ declare namespace Word { */ untrack(): Word.Source; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.SourceData; } /** @@ -120933,9 +121276,9 @@ declare namespace Word { */ untrack(): Word.PageSetup; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.PageSetupData; } /** @@ -121020,9 +121363,9 @@ declare namespace Word { */ untrack(): Word.LineNumbering; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.LineNumberingData; } /** @@ -121139,9 +121482,9 @@ declare namespace Word { */ untrack(): Word.TextColumnCollection; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ toJSON(): Word.Interfaces.TextColumnCollectionData; } /** @@ -121236,9 +121579,9 @@ declare namespace Word { */ untrack(): Word.TextColumn; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. - */ + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.TextColumnData; } /** @@ -121835,16 +122178,16 @@ declare namespace Word { } namespace Interfaces { /** - * Provides ways to load properties of only a subset of members of a collection. - */ + * 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. - */ + * 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. - */ + * 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({ ... })`. */ @@ -121854,11 +122197,11 @@ declare namespace Word { /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ interface ApplicationUpdateData { /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyUpdateData; /** * Specifies if Microsoft Word automatically detects the language you are using as you type. @@ -121871,11 +122214,11 @@ declare namespace Word { /** 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] - */ + * 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. @@ -121978,7 +122321,7 @@ declare namespace Word { /** 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. + * 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] @@ -121999,7 +122342,7 @@ declare namespace Word { */ 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. + * 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] @@ -122028,11 +122371,11 @@ declare namespace Word { /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ interface BreakUpdateData { /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; } /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ @@ -122083,11 +122426,11 @@ declare namespace Word { /** 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] - */ + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeUpdateData; /** * Specifies the comment's content as plain text. @@ -122097,7 +122440,7 @@ declare namespace Word { */ 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. + * 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] @@ -122139,7 +122482,7 @@ declare namespace Word { */ strikeThrough?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * 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] @@ -122149,18 +122492,18 @@ declare namespace Word { /** 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] - */ + * 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] - */ + * 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. @@ -122177,18 +122520,18 @@ declare namespace Word { /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ interface XmlMappingUpdateData { /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; } /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ @@ -122206,46 +122549,46 @@ declare namespace Word { /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ interface CustomXmlNodeUpdateData { /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; /** - * Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; /** * Specifies the value of the current node. @@ -122265,70 +122608,70 @@ declare namespace Word { /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ interface ContentControlUpdateData { /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontUpdateData; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks * [Api set: WordApi 1.1] @@ -122356,21 +122699,21 @@ declare namespace Word { */ placeholderText?: string; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ removeWhenEdited?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * 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. + * 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] @@ -122440,11 +122783,11 @@ declare namespace Word { /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ interface CustomXmlPartUpdateData { /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; } /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ @@ -122458,32 +122801,32 @@ declare namespace Word { /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ interface DocumentUpdateData { /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyUpdateData; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyUpdateData; /** - * Returns a `PageSetup` object that's associated with the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupUpdateData; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * 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. @@ -122531,18 +122874,18 @@ declare namespace Word { /** 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] - */ + * 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] - */ + * 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({ ... })`. */ @@ -122614,11 +122957,11 @@ declare namespace Word { /** 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] - */ + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ result?: Word.Interfaces.RangeUpdateData; /** * Specifies the field's code instruction. @@ -122630,7 +122973,7 @@ declare namespace Word { */ 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. + * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks * [Api set: WordApi 1.5] @@ -122658,53 +123001,53 @@ declare namespace Word { /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ interface FontUpdateData { /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ fill?: Word.Interfaces.FillFormatUpdateData; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ glow?: Word.Interfaces.GlowFormatUpdateData; /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ line?: Word.Interfaces.LineFormatUpdateData; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ reflection?: Word.Interfaces.ReflectionFormatUpdateData; /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textShadow?: Word.Interfaces.ShadowFormatUpdateData; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; /** * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: @@ -122720,7 +123063,7 @@ declare namespace Word { */ allCaps?: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -122740,7 +123083,7 @@ declare namespace Word { */ boldBidirectional?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApi 1.1] @@ -122782,7 +123125,7 @@ declare namespace Word { */ 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. + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -122822,21 +123165,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hidden?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * 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. + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -122870,7 +123213,7 @@ declare namespace Word { */ 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. + * Specifies the name of the font. * * @remarks * [Api set: WordApi 1.1] @@ -122959,7 +123302,7 @@ declare namespace Word { */ shadow?: boolean; /** - * Specifies a value that represents the font size in points. + * Specifies the font size in points. * * @remarks * [Api set: WordApi 1.1] @@ -122993,7 +123336,7 @@ declare namespace Word { */ spacing?: number; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -123007,21 +123350,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ subscript?: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ superscript?: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies the font's underline type. `none` if the font isn't underlined. * * @remarks * [Api set: WordApi 1.1] @@ -123038,11 +123381,11 @@ declare namespace Word { /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ interface HyperlinkUpdateData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** * Specifies the address (for example, a file name or URL) of the hyperlink. @@ -123157,77 +123500,77 @@ declare namespace Word { /** 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] - */ + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontUpdateData; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * 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. + * Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ linkedStyle?: string; /** - * Specifies the number format for the specified list level. + * Specifies the number format for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberFormat?: string; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberPosition?: number; /** - * Specifies the number style for the list level object. + * Specifies the number style for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the list level that must appear before it restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ resetOnHigher?: number; /** - * Specifies the starting number for the specified list level object. + * Specifies the starting number for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ startAt?: number; /** - * Specifies the tab position for the specified list level object. + * Specifies the tab position for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ tabPosition?: number; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ textPosition?: number; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the character inserted after the number for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -123251,18 +123594,18 @@ declare namespace Word { /** 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] - */ + * 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] - */ + * 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({ ... })`. */ @@ -123284,35 +123627,35 @@ declare namespace Word { /** 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] - */ + * 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] - */ + * 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] - */ + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.1] @@ -123504,25 +123847,25 @@ declare namespace Word { /** 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] - */ + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontUpdateData; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listFormat?: Word.Interfaces.ListFormatUpdateData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalUpdateData; /** * Specifies the proofing status (spelling and grammar checking) of the range. @@ -123588,49 +123931,49 @@ declare namespace Word { /** 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. + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignorePunct?: boolean; /** - * 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. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignoreSpace?: boolean; /** - * 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. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchCase?: boolean; /** - * 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. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchPrefix?: boolean; /** - * 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. + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchSuffix?: boolean; /** - * 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. + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchWholeWord?: boolean; /** - * 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. + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] @@ -123640,18 +123983,18 @@ declare namespace Word { /** 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] - */ + * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyUpdateData; /** - * Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupUpdateData; /** * Specifies if the section is protected for forms. @@ -123686,60 +124029,60 @@ declare namespace Word { /** 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] - */ + * Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderCollectionUpdateData; /** - * Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontUpdateData; /** - * Returns a `Frame` object that represents the frame formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frame?: Word.Interfaces.FrameUpdateData; /** - * Specifies a link between a paragraph and a character style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ linkStyle?: Word.Interfaces.StyleUpdateData; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `ListTemplate` object that represents the list formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingUpdateData; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * 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. @@ -123786,7 +124129,7 @@ declare namespace Word { */ 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. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks * [Api set: WordApi 1.5] @@ -123816,14 +124159,14 @@ declare namespace Word { */ 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. + * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks * [Api set: WordApi 1.5] */ unhideWhenUsed?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] @@ -123895,14 +124238,14 @@ declare namespace Word { /** 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] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontUpdateData; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApi 1.3] @@ -123916,7 +124259,7 @@ declare namespace Word { */ headerRowCount?: number; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] @@ -123986,7 +124329,7 @@ declare namespace Word { */ values?: string[][]; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -124010,7 +124353,7 @@ declare namespace Word { */ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -124059,11 +124402,11 @@ declare namespace Word { /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ interface TableColumnUpdateData { /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalUpdateData; /** * Specifies the preferred width (in points or as a percentage of the window width) for the column. @@ -124095,14 +124438,14 @@ declare namespace Word { /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ interface TableRowUpdateData { /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontUpdateData; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -124130,7 +124473,7 @@ declare namespace Word { */ values?: string[][]; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -124144,11 +124487,11 @@ declare namespace Word { /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ interface TableCellUpdateData { /** - * Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyUpdateData; /** * Specifies the width of the cell's column in points. This is applicable to uniform tables. @@ -124158,7 +124501,7 @@ declare namespace Word { */ columnWidth?: number; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -124179,7 +124522,7 @@ declare namespace Word { */ value?: string; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -124298,60 +124641,60 @@ declare namespace Word { /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ interface ShapeUpdateData { /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ body?: Word.Interfaces.BodyUpdateData; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ canvas?: Word.Interfaces.CanvasUpdateData; /** - * Returns the fill formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the fill formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ fill?: Word.Interfaces.ShapeFillUpdateData; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentCanvas?: Word.Interfaces.ShapeUpdateData; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentGroup?: Word.Interfaces.ShapeUpdateData; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; /** - * Gets the text frame object of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `TextFrame` object of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textFrame?: Word.Interfaces.TextFrameUpdateData; /** - * Returns the text wrap formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; /** * Specifies whether a given shape can overlap other shapes. @@ -124490,21 +124833,21 @@ declare namespace Word { /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ interface ShapeGroupUpdateData { /** - * Gets the Shape object associated with the group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeUpdateData; } /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ interface CanvasUpdateData { /** - * Gets the Shape object associated with the canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeUpdateData; } /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ @@ -124538,56 +124881,56 @@ declare namespace Word { /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ interface TextFrameUpdateData { /** - * 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 automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks * [Api set: WordApiDesktop 1.2] */ autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the bottom margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ bottomMargin?: number; /** - * Represents the left margin, in points, of the text frame. + * Specifies the left margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ leftMargin?: number; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. * * @remarks * [Api set: WordApiDesktop 1.2] */ noTextRotation?: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks * [Api set: WordApiDesktop 1.2] */ orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Represents the right margin, in points, of the text frame. + * Specifies the right margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ rightMargin?: number; /** - * Represents the top margin, in points, of the text frame. + * Specifies the top margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ topMargin?: number; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -124649,35 +124992,35 @@ declare namespace Word { /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ interface RepeatingSectionItemUpdateData { /** - * Returns the range of this repeating section item, excluding the start and end tags. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; } /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ interface DatePickerContentControlUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** * Specifies the appearance of the content control. @@ -124760,25 +125103,25 @@ declare namespace Word { /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ interface PictureContentControlUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** * Specifies the appearance of the content control. @@ -124833,25 +125176,25 @@ declare namespace Word { /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ interface GroupContentControlUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** * Specifies the appearance of the content control. @@ -124906,25 +125249,25 @@ declare namespace Word { /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ interface BuildingBlockGalleryContentControlUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** * Specifies the appearance of the content control. @@ -124993,18 +125336,18 @@ declare namespace Word { /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ interface RepeatingSectionContentControlUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. @@ -125073,18 +125416,18 @@ declare namespace Word { /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ interface FrameUpdateData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeUpdateData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalUpdateData; /** * Specifies the height (in points) of the frame. @@ -125182,11 +125525,11 @@ declare namespace Word { /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ interface ListFormatUpdateData { /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** * Specifies the list level number for the first paragraph for the `ListFormat` object. @@ -125199,18 +125542,18 @@ declare namespace Word { /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ interface FillFormatUpdateData { /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. @@ -125286,11 +125629,11 @@ declare namespace Word { /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ interface GlowFormatUpdateData { /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ color?: Word.Interfaces.ColorFormatUpdateData; /** * Specifies the length of the radius for a glow effect. @@ -125310,18 +125653,18 @@ declare namespace Word { /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ interface LineFormatUpdateData { /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** * Specifies the length of the arrowhead at the beginning of the line. @@ -125487,11 +125830,11 @@ declare namespace Word { /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ interface ShadowFormatUpdateData { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. @@ -125570,18 +125913,18 @@ declare namespace Word { /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ interface ThreeDimensionalFormatUpdateData { /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ contourColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ extrusionColor?: Word.Interfaces.ColorFormatUpdateData; /** * Specifies the depth of the bottom bevel. @@ -125757,11 +126100,11 @@ declare namespace Word { /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ interface PageSetupUpdateData { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lineNumbering?: Word.Interfaces.LineNumberingUpdateData; /** * Specifies whether Microsoft Word prints the document as a booklet. @@ -126032,7 +126375,7 @@ declare namespace Word { /** An interface describing the data returned by calling `annotation.toJSON()`. */ interface AnnotationData { /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. * * @remarks * [Api set: WordApi 1.7] @@ -126053,11 +126396,11 @@ declare namespace Word { /** An interface describing the data returned by calling `application.toJSON()`. */ interface ApplicationData { /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyData; /** * Specifies if Microsoft Word automatically detects the language you are using as you type. @@ -126077,62 +126420,64 @@ declare namespace Word { /** An interface describing the data returned by calling `body.toJSON()`. */ interface BodyData { /** - * Gets the collection of rich text content control objects in the body. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of rich text content control objects in the body. + * + * @remarks + * [Api set: WordApi 1.1] + */ contentControls?: Word.Interfaces.ContentControlData[]; /** - * Gets the collection of field objects in the body. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of `Field` objects in the body. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontData; /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `InlinePicture` objects in the body. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the collection of list objects in the body. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of `List` objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ lists?: Word.Interfaces.ListData[]; /** - * Gets the collection of paragraph objects in the body. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. - */ + * Gets the collection of `Paragraph` objects in the body. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. + */ paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of `Shape` objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + */ shapes?: Word.Interfaces.ShapeData[]; /** - * Gets the collection of table objects in the body. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of `Table` objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ tables?: Word.Interfaces.TableData[]; /** * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. @@ -126156,7 +126501,7 @@ declare namespace Word { */ text?: string; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * Gets the type of the body. The type can be `mainDoc`, `section`, `header`, `footer`, or `tableCell`. Additional types `footnote`, `endnote`, and `noteItem` are supported in WordApi 1.5 and later. * * @remarks * [Api set: WordApi 1.3] @@ -126271,11 +126616,11 @@ declare namespace Word { /** An interface describing the data returned by calling `break.toJSON()`. */ interface BreakData { /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** * Returns the page number on which the break occurs. @@ -126381,18 +126726,18 @@ declare namespace Word { /** An interface describing the data returned by calling `comment.toJSON()`. */ interface CommentData { /** - * Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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] - */ + * 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. @@ -126430,7 +126775,7 @@ declare namespace Word { */ id?: string; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * 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] @@ -126486,7 +126831,7 @@ declare namespace Word { */ text?: string; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * 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] @@ -126552,18 +126897,18 @@ declare namespace Word { /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ interface XmlMappingData { /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlNode?: Word.Interfaces.CustomXmlNodeData; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlPart?: Word.Interfaces.CustomXmlPartData; /** * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. @@ -126636,60 +126981,60 @@ declare namespace Word { /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ interface CustomXmlNodeData { /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ attributes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ childNodes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ firstChild?: Word.Interfaces.CustomXmlNodeData; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lastChild?: Word.Interfaces.CustomXmlNodeData; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ nextSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ ownerPart?: Word.Interfaces.CustomXmlPartData; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ parentNode?: Word.Interfaces.CustomXmlNodeData; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ previousSibling?: Word.Interfaces.CustomXmlNodeData; /** * Gets the base name of the node without the namespace prefix, if one exists. @@ -126744,128 +127089,128 @@ declare namespace Word { /** An interface describing the data returned by calling `contentControl.toJSON()`. */ interface ContentControlData { /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; /** - * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.9] - */ + * Gets the data of the content control when its type is `comboBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** - * Gets the collection of content control objects in the content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `ContentControl` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ contentControls?: Word.Interfaces.ContentControlData[]; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; /** - * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.9] - */ + * Gets the data of the content control when its type is `dropDownList`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** - * Gets the collection of field objects in the content control. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of `Field` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontData; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ groupContentControl?: Word.Interfaces.GroupContentControlData; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `InlinePicture` objects in the content control. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the collection of list objects in the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of `List` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ lists?: Word.Interfaces.ListData[]; /** - * Gets the collection of paragraph objects in the content control. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. - */ + * Gets the collection of `Paragraph` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + */ paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pictureContentControl?: Word.Interfaces.PictureContentControlData; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; /** - * Gets the collection of table objects in the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the collection of `Table` objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ tables?: Word.Interfaces.TableData[]; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks * [Api set: WordApi 1.1] @@ -126900,28 +127245,28 @@ declare namespace Word { */ placeholderText?: string; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ removeWhenEdited?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * 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. + * 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. + * Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. * * @remarks * [Api set: WordApi 1.3] @@ -126949,7 +127294,7 @@ declare namespace Word { */ title?: string; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. * * @remarks * [Api set: WordApi 1.1] @@ -127019,25 +127364,25 @@ declare namespace Word { /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ interface CustomXmlPartData { /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentElement?: Word.Interfaces.CustomXmlNodeData; /** - * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; /** - * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; /** * Gets a value that indicates whether the `CustomXmlPart` is built-in. @@ -127079,95 +127424,95 @@ declare namespace Word { /** An interface describing the data returned by calling `document.toJSON()`. */ interface DocumentData { /** - * Gets the active window for the document. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ activeWindow?: Word.Interfaces.WindowData; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyData; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyData; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ contentControls?: Word.Interfaces.ContentControlData[]; /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ customXmlParts?: Word.Interfaces.CustomXmlPartData[]; /** - * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; /** - * Returns a `FrameCollection` object that represents all the frames in the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `FrameCollection` object that represents all the frames in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frames?: Word.Interfaces.FrameData[]; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Returns a `PageSetup` object that's associated with the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupData; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesData; /** - * Gets the collection of section objects in the document. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `Section` objects in the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ sections?: Word.Interfaces.SectionData[]; /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ settings?: Word.Interfaces.SettingData[]; /** - * Gets the collection of `Word.Window` objects for the document. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of `Word.Window` objects for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ windows?: Word.Interfaces.WindowData[]; /** * Specifies if automatic hyphenation is turned on for the document. @@ -127212,7 +127557,7 @@ declare namespace Word { */ 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. + * 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] @@ -127222,14 +127567,14 @@ declare namespace Word { /** 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. + * 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. + * Gets the collection of `ContentControl` objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -127250,7 +127595,7 @@ declare namespace Word { */ properties?: Word.Interfaces.DocumentPropertiesData; /** - * Gets the collection of section objects in the document. + * Gets the collection of `Section` objects in the document. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -127264,7 +127609,7 @@ declare namespace Word { */ settings?: Word.Interfaces.SettingData[]; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -127425,7 +127770,7 @@ declare namespace Word { */ 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. + * Specifies data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks * [Api set: WordApi 1.5] @@ -127467,60 +127812,60 @@ declare namespace Word { /** An interface describing the data returned by calling `font.toJSON()`. */ interface FontData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ fill?: Word.Interfaces.FillFormatData; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ glow?: Word.Interfaces.GlowFormatData; /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ line?: Word.Interfaces.LineFormatData; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ reflection?: Word.Interfaces.ReflectionFormatData; /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textColor?: Word.Interfaces.ColorFormatData; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textShadow?: Word.Interfaces.ShadowFormatData; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; /** * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: @@ -127536,7 +127881,7 @@ declare namespace Word { */ allCaps?: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -127556,7 +127901,7 @@ declare namespace Word { */ boldBidirectional?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApi 1.1] @@ -127598,7 +127943,7 @@ declare namespace Word { */ 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. + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -127638,21 +127983,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hidden?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * 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. + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -127686,7 +128031,7 @@ declare namespace Word { */ 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. + * Specifies the name of the font. * * @remarks * [Api set: WordApi 1.1] @@ -127775,7 +128120,7 @@ declare namespace Word { */ shadow?: boolean; /** - * Specifies a value that represents the font size in points. + * Specifies the font size in points. * * @remarks * [Api set: WordApi 1.1] @@ -127809,7 +128154,7 @@ declare namespace Word { */ spacing?: number; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -127823,21 +128168,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ subscript?: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ superscript?: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies the font's underline type. `none` if the font isn't underlined. * * @remarks * [Api set: WordApi 1.1] @@ -127854,11 +128199,11 @@ declare namespace Word { /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ interface HyperlinkData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** * Specifies the address (for example, a file name or URL) of the hyperlink. @@ -127994,21 +128339,21 @@ declare namespace Word { */ paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the list's id. + * Gets the list's ID. * * @remarks * [Api set: WordApi 1.3] */ id?: 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. + * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks * [Api set: WordApi 1.3] */ levelExistences?: boolean[]; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. * * @remarks * [Api set: WordApi 1.3] @@ -128046,77 +128391,77 @@ declare namespace Word { /** An interface describing the data returned by calling `listLevel.toJSON()`. */ interface ListLevelData { /** - * Gets a Font object that represents the character formatting of the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontData; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * 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. + * Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ linkedStyle?: string; /** - * Specifies the number format for the specified list level. + * Specifies the number format for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberFormat?: string; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberPosition?: number; /** - * Specifies the number style for the list level object. + * Specifies the number style for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the list level that must appear before it restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ resetOnHigher?: number; /** - * Specifies the starting number for the specified list level object. + * Specifies the starting number for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ startAt?: number; /** - * Specifies the tab position for the specified list level object. + * Specifies the tab position for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ tabPosition?: number; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ textPosition?: number; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the character inserted after the number for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -128130,11 +128475,11 @@ declare namespace Word { /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ interface ListTemplateData { /** - * Gets a `ListLevelCollection` object that represents all the levels for the list template. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * 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 list template is outline numbered. @@ -128147,18 +128492,18 @@ declare namespace Word { /** An interface describing the data returned by calling `noteItem.toJSON()`. */ interface NoteItemData { /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ body?: Word.Interfaces.BodyData; /** - * Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ reference?: Word.Interfaces.RangeData; /** * Represents the note item type: footnote or endnote. @@ -128175,11 +128520,11 @@ declare namespace Word { /** An interface describing the data returned by calling `page.toJSON()`. */ interface PageData { /** - * Gets a `BreakCollection` object that represents the breaks on the page. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `BreakCollection` object that represents the breaks on the page. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ breaks?: Word.Interfaces.BreakData[]; /** * Gets the height, in points, of the paper defined in the Page Setup dialog box. @@ -128210,18 +128555,18 @@ declare namespace Word { /** An interface describing the data returned by calling `pane.toJSON()`. */ interface PaneData { /** - * Gets the collection of pages in the pane. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of pages in the pane. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ pages?: Word.Interfaces.PageData[]; /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ pagesEnclosingViewport?: Word.Interfaces.PageData[]; } /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ @@ -128238,63 +128583,65 @@ declare namespace Word { /** An interface describing the data returned by calling `paragraph.toJSON()`. */ interface ParagraphData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Gets the collection of fields in the paragraph. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of fields in the paragraph. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontData; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the collection of `InlinePicture` objects in the paragraph. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItem?: Word.Interfaces.ListItemData; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItemOrNullObject?: Word.Interfaces.ListItemData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalData; /** - * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of `Shape` objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + */ shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.1] @@ -128521,81 +128868,83 @@ declare namespace Word { /** An interface describing the data returned by calling `range.toJSON()`. */ interface RangeData { /** - * Gets the collection of field objects in the range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * 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 range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * 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 a `FrameCollection` object that represents all the frames in the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `FrameCollection` object that represents all the frames in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frames?: Word.Interfaces.FrameData[]; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Gets the collection of inline picture objects in the range. - * - * @remarks - * [Api set: WordApi 1.2] - */ + * Gets the collection of `InlinePicture` objects in the range. + * + * @remarks + * [Api set: WordApi 1.2] + */ inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listFormat?: Word.Interfaces.ListFormatData; /** - * Gets the collection of pages in the range. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of pages in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ pages?: Word.Interfaces.PageData[]; /** - * Gets the collection of sections in the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the collection of sections in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ sections?: Word.Interfaces.SectionData[]; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalData; /** - * 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: WordApiDesktop 1.2] - */ + * 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: WordApiDesktop 1.2] + * + * Important: Be aware that with time, additional types of shapes may be supported. Therefore, your add-in should request and handle specific types of shapes. + */ shapes?: Word.Interfaces.ShapeData[]; /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ tableColumns?: Word.Interfaces.TableColumnData[]; /** * Specifies the proofing status (spelling and grammar checking) of the range. @@ -128675,49 +129024,49 @@ declare namespace Word { /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ interface SearchOptionsData { /** - * 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. + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignorePunct?: boolean; /** - * 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. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignoreSpace?: boolean; /** - * 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. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchCase?: boolean; /** - * 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. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchPrefix?: boolean; /** - * 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. + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchSuffix?: boolean; /** - * 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. + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchWholeWord?: boolean; /** - * 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. + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] @@ -128727,25 +129076,25 @@ declare namespace Word { /** An interface describing the data returned by calling `section.toJSON()`. */ interface SectionData { /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * 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.BodyData; /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupData; /** * Specifies if the section is protected for forms. @@ -128787,60 +129136,60 @@ declare namespace Word { /** An interface describing the data returned by calling `style.toJSON()`. */ interface StyleData { /** - * Specifies a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderData[]; /** - * Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontData; /** - * Returns a `Frame` object that represents the frame formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frame?: Word.Interfaces.FrameData; /** - * Specifies a link between a paragraph and a character style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ linkStyle?: Word.Interfaces.StyleData; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `ListTemplate` object that represents the list formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateData; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatData; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingData; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a `TableStyle` object representing style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ tableStyle?: Word.Interfaces.TableStyleData; /** * Specifies whether the style is automatically redefined based on the selection. @@ -128859,7 +129208,7 @@ declare namespace Word { */ baseStyle?: string; /** - * Gets whether the specified style is a built-in style. + * Gets whether the style is a built-in style. * * @remarks * [Api set: WordApi 1.5] @@ -128873,7 +129222,7 @@ declare namespace Word { */ hasProofing?: boolean; /** - * 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. + * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks * [Api set: WordApi 1.5] @@ -128894,7 +129243,7 @@ declare namespace Word { */ 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 whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks * [Api set: WordApi 1.5] @@ -128915,14 +129264,14 @@ declare namespace Word { */ locked?: boolean; /** - * Gets the name of a style in the language of the user. + * Gets the name of the style in the language of the user. * * @remarks * [Api set: WordApi 1.5] */ nameLocal?: string; /** - * 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 name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks * [Api set: WordApi 1.5] @@ -128959,14 +129308,14 @@ declare namespace Word { */ type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * 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 whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks * [Api set: WordApi 1.5] */ unhideWhenUsed?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] @@ -129038,35 +129387,35 @@ declare namespace Word { /** An interface describing the data returned by calling `table.toJSON()`. */ interface TableData { /** - * Gets the collection of field objects in the table. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the collection of `Field` objects in the table. + * + * @remarks + * [Api set: WordApi 1.4] + */ fields?: Word.Interfaces.FieldData[]; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontData; /** - * Gets all of the table rows. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets all of the table rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ rows?: Word.Interfaces.TableRowData[]; /** - * Gets the child tables nested one level deeper. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the child tables nested one level deeper. + * + * @remarks + * [Api set: WordApi 1.3] + */ tables?: Word.Interfaces.TableData[]; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApi 1.3] @@ -129080,7 +129429,7 @@ declare namespace Word { */ headerRowCount?: number; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] @@ -129171,7 +129520,7 @@ declare namespace Word { */ values?: string[][]; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -129195,7 +129544,7 @@ declare namespace Word { */ alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -129244,18 +129593,18 @@ declare namespace Word { /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ interface TableColumnData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalData; /** * Returns the position of this column in a collection. @@ -129322,7 +129671,7 @@ declare namespace Word { */ cells?: Word.Interfaces.TableCellData[]; /** - * Gets the collection of field objects in the table row. + * Gets the collection of `Field` objects in the table row. * * @remarks * [Api set: WordApi 1.4] @@ -129343,14 +129692,14 @@ declare namespace Word { */ cellCount?: number; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] */ horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks * [Api set: WordApi 1.3] @@ -129385,7 +129734,7 @@ declare namespace Word { */ values?: string[][]; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -129399,11 +129748,11 @@ declare namespace Word { /** An interface describing the data returned by calling `tableCell.toJSON()`. */ interface TableCellData { /** - * Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyData; /** * Gets the index of the cell in its row. @@ -129420,7 +129769,7 @@ declare namespace Word { */ columnWidth?: number; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -129448,7 +129797,7 @@ declare namespace Word { */ value?: string; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -129633,60 +129982,60 @@ declare namespace Word { /** An interface describing the data returned by calling `shape.toJSON()`. */ interface ShapeData { /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ body?: Word.Interfaces.BodyData; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ canvas?: Word.Interfaces.CanvasData; /** - * Returns the fill formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the fill formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ fill?: Word.Interfaces.ShapeFillData; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentCanvas?: Word.Interfaces.ShapeData; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentGroup?: Word.Interfaces.ShapeData; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapeGroup?: Word.Interfaces.ShapeGroupData; /** - * Gets the text frame object of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `TextFrame` object of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textFrame?: Word.Interfaces.TextFrameData; /** - * Returns the text wrap formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textWrap?: Word.Interfaces.ShapeTextWrapData; /** * Specifies whether a given shape can overlap other shapes. @@ -129846,18 +130195,18 @@ declare namespace Word { /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ interface ShapeGroupData { /** - * Gets the Shape object associated with the group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeData; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of `Shape` objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapes?: Word.Interfaces.ShapeData[]; /** * Gets an integer that represents the shape group identifier. @@ -129870,18 +130219,18 @@ declare namespace Word { /** An interface describing the data returned by calling `canvas.toJSON()`. */ interface CanvasData { /** - * Gets the Shape object associated with the canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeData; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the collection of {@link Word.Shape} objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapes?: Word.Interfaces.ShapeData[]; /** * Gets an integer that represents the canvas identifier. @@ -129929,63 +130278,63 @@ declare namespace Word { /** An interface describing the data returned by calling `textFrame.toJSON()`. */ interface TextFrameData { /** - * 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 automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks * [Api set: WordApiDesktop 1.2] */ autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the bottom margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ bottomMargin?: number; /** - * Specifies if the text frame contains text. + * Returns `true` if the text frame contains text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hasText?: boolean; /** - * Represents the left margin, in points, of the text frame. + * Specifies the left margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ leftMargin?: number; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. * * @remarks * [Api set: WordApiDesktop 1.2] */ noTextRotation?: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks * [Api set: WordApiDesktop 1.2] */ orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Represents the right margin, in points, of the text frame. + * Specifies the right margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ rightMargin?: number; /** - * Represents the top margin, in points, of the text frame. + * Specifies the top margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ topMargin?: number; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -130047,35 +130396,35 @@ declare namespace Word { /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ interface RepeatingSectionItemData { /** - * Returns the range of this repeating section item, excluding the start and end tags. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; } /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ interface DatePickerContentControlData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. @@ -130179,25 +130528,25 @@ declare namespace Word { /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ interface PictureContentControlData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. @@ -130273,25 +130622,25 @@ declare namespace Word { /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ interface GroupContentControlData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. @@ -130367,25 +130716,25 @@ declare namespace Word { /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ interface BuildingBlockGalleryContentControlData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingData; /** * Specifies the appearance of the content control. @@ -130475,18 +130824,18 @@ declare namespace Word { /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ interface RepeatingSectionContentControlData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. @@ -130576,25 +130925,25 @@ declare namespace Word { /** An interface describing the data returned by calling `frame.toJSON()`. */ interface FrameData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalData; /** * Specifies the height (in points) of the frame. @@ -130716,18 +131065,18 @@ declare namespace Word { /** An interface describing the data returned by calling `listFormat.toJSON()`. */ interface ListFormatData { /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ list?: Word.Interfaces.ListData; /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listTemplate?: Word.Interfaces.ListTemplateData; /** * Indicates whether the `ListFormat` object contains a single list. @@ -130775,18 +131124,18 @@ declare namespace Word { /** 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: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatData; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatData; /** * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. @@ -130935,11 +131284,11 @@ declare namespace Word { /** 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: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ color?: Word.Interfaces.ColorFormatData; /** * Specifies the length of the radius for a glow effect. @@ -130959,18 +131308,18 @@ declare namespace Word { /** 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: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatData; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatData; /** * Specifies the length of the arrowhead at the beginning of the line. @@ -131143,11 +131492,11 @@ declare namespace Word { /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ interface ShadowFormatData { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatData; /** * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. @@ -131226,18 +131575,18 @@ declare namespace Word { /** 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: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ contourColor?: Word.Interfaces.ColorFormatData; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ extrusionColor?: Word.Interfaces.ColorFormatData; /** * Specifies the depth of the bottom bevel. @@ -131420,11 +131769,11 @@ declare namespace Word { /** An interface describing the data returned by calling `bibliography.toJSON()`. */ interface BibliographyData { /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ sources?: Word.Interfaces.SourceData[]; /** * Specifies the name of the active style to use for the bibliography. @@ -131465,18 +131814,18 @@ declare namespace Word { /** 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: WordApiDesktop 1.3] - */ + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lineNumbering?: Word.Interfaces.LineNumberingData; /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textColumns?: Word.Interfaces.TextColumnData[]; /** * Specifies whether Microsoft Word prints the document as a booklet. @@ -131746,11 +132095,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the range of text that is annotated. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the range of text that is annotated. + * + * @remarks + * [Api set: WordApi 1.7] + */ range?: Word.Interfaces.RangeLoadOptions; /** * Gets the critique that was passed when the annotation was inserted. @@ -131772,14 +132121,14 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the critique annotation object. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the `CritiqueAnnotation` object. + * + * @remarks + * [Api set: WordApi 1.7] + */ critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. * * @remarks * [Api set: WordApi 1.7] @@ -131805,14 +132154,14 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the critique annotation object. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * For EACH ITEM in the collection: Gets the `CritiqueAnnotation` object. + * + * @remarks + * [Api set: WordApi 1.7] + */ critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of `Annotation` objects. * * @remarks * [Api set: WordApi 1.7] @@ -131827,7 +132176,7 @@ declare namespace Word { state?: boolean; } /** - * Represents the application object. + * Represents the `Application` object. * * @remarks * [Api set: WordApi 1.3] @@ -131838,11 +132187,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyLoadOptions; /** * Specifies if Microsoft Word automatically detects the language you are using as you type. @@ -131871,53 +132220,53 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the body. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentSection?: Word.Interfaces.SectionLoadOptions; /** - * Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent section of the body. If there isn't a parent section, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; /** * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. @@ -131941,7 +132290,7 @@ declare namespace Word { */ text?: 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. + * Gets the type of the body. The type can be `mainDoc`, `section`, `header`, `footer`, or `tableCell`. Additional types `footnote`, `endnote`, and `noteItem` are supported in WordApi 1.5 and later. * * @remarks * [Api set: WordApi 1.3] @@ -131949,7 +132298,7 @@ declare namespace Word { type?: boolean; } /** - * Represents the Border object for text, a paragraph, or a table. + * Represents the `Border` object for text, a paragraph, or a table. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -132179,7 +132528,7 @@ declare namespace Word { lineWidth?: boolean; } /** - * Represents a break in a Word document. + * Represents a break in a Word document. This could be a page, column, or section break. * * @remarks * [Api set: WordApiDesktop 1.3] @@ -132190,11 +132539,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** * Returns the page number on which the break occurs. @@ -132216,11 +132565,11 @@ declare namespace Word { */ $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: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Returns the page number on which the break occurs. @@ -132242,18 +132591,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlockCategory` object that represents the category for the building block. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlockCategory` object that represents the category for the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; /** - * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** * Specifies the description for the building block. @@ -132310,11 +132659,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** * Returns the position of the `BuildingBlockCategory` object in a collection. @@ -132388,11 +132737,11 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** * Gets the email of the comment's author. @@ -132430,7 +132779,7 @@ declare namespace Word { */ 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 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] @@ -132449,11 +132798,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** * For EACH ITEM in the collection: Gets the email of the comment's author. @@ -132491,7 +132840,7 @@ declare namespace Word { */ id?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * For EACH ITEM in the collection: 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] @@ -132550,7 +132899,7 @@ declare namespace Word { */ text?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * 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] @@ -132569,18 +132918,18 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentComment?: Word.Interfaces.CommentLoadOptions; /** * Gets the email of the comment reply's author. @@ -132630,18 +132979,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentComment?: Word.Interfaces.CommentLoadOptions; /** * For EACH ITEM in the collection: Gets the email of the comment reply's author. @@ -132691,18 +133040,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. @@ -132842,46 +133191,46 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. @@ -132945,46 +133294,46 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** * Gets the base name of the node without the namespace prefix, if one exists. @@ -133048,119 +133397,119 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Gets the parent body of the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the content control. + * + * @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] - */ + * 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; /** - * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * 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] - */ + * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks * [Api set: WordApi 1.1] @@ -133195,28 +133544,28 @@ declare namespace Word { */ placeholderText?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ removeWhenEdited?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * 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?: 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 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?: boolean; /** - * 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. + * Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. * * @remarks * [Api set: WordApi 1.3] @@ -133244,7 +133593,7 @@ declare namespace Word { */ title?: boolean; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets the content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. * * @remarks * [Api set: WordApi 1.1] @@ -133263,119 +133612,119 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `buildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ + * For EACH ITEM in the collection: Gets the data of the content control when its type is `checkBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `datePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets 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] - */ + * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: 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] - */ + * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `repeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * 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.1] */ appearance?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with `removeWhenEdited`. * * @remarks * [Api set: WordApi 1.1] @@ -133410,28 +133759,28 @@ declare namespace Word { */ placeholderText?: boolean; /** - * 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: Specifies a value that indicates whether the content control is removed after it's edited. Mutually exclusive with `cannotDelete`. * * @remarks * [Api set: WordApi 1.1] */ removeWhenEdited?: boolean; /** - * 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: 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?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * 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 1.3] */ styleBuiltIn?: 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: Gets the content control subtype. The subtype can be `richTextInline`, `richTextParagraphs`, `richTextTableCell`, `richTextTableRow` and `richTextTable` for rich text content controls, `plainTextInline` and `plainTextParagraph` for plain text content controls, `checkBox` for checkbox content controls, `dropDownList` for dropdown list content controls, `comboBox` for combo box content controls, `buildingBlockGallery` for building block gallery content controls, `datePicker` for date picker content controls, `repeatingSection` for repeating section content controls, `picture` for picture content controls, and `group` for group content controls. * * @remarks * [Api set: WordApi 1.3] @@ -133459,7 +133808,7 @@ declare namespace Word { */ title?: 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 content control type. Only rich text, plain text, check box, dropdown list, combo box, building block gallery, date picker, repeating section, picture, and group content controls are supported currently. * * @remarks * [Api set: WordApi 1.1] @@ -133610,11 +133959,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** * Gets a value that indicates whether the `CustomXmlPart` is built-in. @@ -133657,11 +134006,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. @@ -133704,11 +134053,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. @@ -133740,7 +134089,7 @@ declare namespace Word { 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. + * 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] @@ -133751,39 +134100,39 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies a `Template` object that represents the template attached to the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a `Template` object that represents the template attached to the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ attachedTemplate?: Word.Interfaces.TemplateLoadOptions; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * 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: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** * Specifies if automatic hyphenation is turned on for the document. @@ -133828,7 +134177,7 @@ declare namespace Word { */ 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. + * 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] @@ -133836,7 +134185,7 @@ declare namespace Word { saved?: boolean; } /** - * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. + * 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] @@ -133847,21 +134196,21 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ + * Gets the `Body` object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * Indicates whether the changes in the document have been saved. A value of `true` indicates that the document hasn't changed since it was saved. * * @remarks * [Api set: WordApiHiddenDocument 1.3] @@ -134015,60 +134364,60 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the parent body of the field. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the parent body of the field. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ result?: Word.Interfaces.RangeLoadOptions; /** * Specifies the field's code instruction. @@ -134080,7 +134429,7 @@ declare namespace Word { */ code?: 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 data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks * [Api set: WordApi 1.5] @@ -134131,60 +134480,60 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the parent body of the field. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the parent body of the field. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.4] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ + * For EACH ITEM in the collection: Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ result?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies the field's code instruction. @@ -134196,7 +134545,7 @@ declare namespace Word { */ code?: 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 data in a field of `addin` type. If the field isn't an `addin` type, it's `null` and it will throw a general exception when code attempts to set it. * * @remarks * [Api set: WordApi 1.5] @@ -134243,53 +134592,53 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ fill?: Word.Interfaces.FillFormatLoadOptions; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ glow?: Word.Interfaces.GlowFormatLoadOptions; /** - * Returns a `LineFormat` object that specifies the formatting for a line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ line?: Word.Interfaces.LineFormatLoadOptions; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ reflection?: Word.Interfaces.ReflectionFormatLoadOptions; /** - * Returns a `ColorFormat` object that represents the color for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ textShadow?: Word.Interfaces.ShadowFormatLoadOptions; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatLoadOptions; /** * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: @@ -134305,7 +134654,7 @@ declare namespace Word { */ allCaps?: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies whether the font is bold. `true` if the font is formatted as bold, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -134325,7 +134674,7 @@ declare namespace Word { */ boldBidirectional?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the color for the font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApi 1.1] @@ -134367,7 +134716,7 @@ declare namespace Word { */ 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. + * Specifies whether the font has a double strikethrough. `true` if the font is formatted as double strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -134407,21 +134756,21 @@ declare namespace Word { */ 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. + * Specifies whether the font is tagged as hidden. `true` if the font is formatted as hidden text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hidden?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * 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?: boolean; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies whether the font is italicized. `true` if the font is italicized, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -134455,7 +134804,7 @@ declare namespace Word { */ ligature?: boolean; /** - * Specifies a value that represents the name of the font. + * Specifies the name of the font. * * @remarks * [Api set: WordApi 1.1] @@ -134544,7 +134893,7 @@ declare namespace Word { */ shadow?: boolean; /** - * Specifies a value that represents the font size in points. + * Specifies the font size in points. * * @remarks * [Api set: WordApi 1.1] @@ -134578,7 +134927,7 @@ declare namespace Word { */ spacing?: boolean; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies whether the font has a strikethrough. `true` if the font is formatted as strikethrough text, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] @@ -134592,21 +134941,21 @@ declare namespace Word { */ stylisticSet?: boolean; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Specifies whether the font is a subscript. `true` if the font is formatted as subscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ subscript?: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies whether the font is a superscript. `true` if the font is formatted as superscript, otherwise, `false`. * * @remarks * [Api set: WordApi 1.1] */ superscript?: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies the font's underline type. `none` if the font isn't underlined. * * @remarks * [Api set: WordApi 1.1] @@ -134632,11 +134981,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies the address (for example, a file name or URL) of the hyperlink. @@ -134714,11 +135063,11 @@ declare namespace Word { */ $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: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. @@ -134796,53 +135145,53 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the parent paragraph that contains the inline image. - * - * @remarks - * [Api set: WordApi 1.2] - */ + * 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] - */ + * 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] - */ + * 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] - */ + * 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] - */ + * 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}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * Specifies a string that represents the alternative text associated with the inline image. @@ -134906,53 +135255,53 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. - * - * @remarks - * [Api set: WordApi 1.2] - */ + * 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] - */ + * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. @@ -135016,21 +135365,21 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the list's id. + * Gets the list's ID. * * @remarks * [Api set: WordApi 1.3] */ id?: 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. + * Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks * [Api set: WordApi 1.3] */ levelExistences?: boolean; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Gets all 9 level types in the list. Each type can be `bullet`, `number`, or `picture`. * * @remarks * [Api set: WordApi 1.3] @@ -135049,21 +135398,21 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the list's id. + * For EACH ITEM in the collection: Gets the list's ID. * * @remarks * [Api set: WordApi 1.3] */ id?: 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. + * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. `true` indicates the level exists, which means there's at least one list item at that level. * * @remarks * [Api set: WordApi 1.3] */ levelExistences?: boolean; /** - * For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * 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.3] @@ -135115,77 +135464,77 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApiDesktop 1.1] */ alignment?: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ linkedStyle?: boolean; /** - * Specifies the number format for the specified list level. + * Specifies the number format for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberFormat?: boolean; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberPosition?: boolean; /** - * Specifies the number style for the list level object. + * Specifies the number style for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberStyle?: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the list level that must appear before it restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ resetOnHigher?: boolean; /** - * Specifies the starting number for the specified list level object. + * Specifies the starting number for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ startAt?: boolean; /** - * Specifies the tab position for the specified list level object. + * Specifies the tab position for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ tabPosition?: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ textPosition?: boolean; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the character inserted after the number for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -135204,77 +135553,77 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * For EACH ITEM in the collection: Gets a `Font` object that represents the character formatting of the `ListLevel` object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * 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: Specifies the horizontal alignment of the list level. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApiDesktop 1.1] */ alignment?: boolean; /** - * 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: Specifies the name of the style that's linked to the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ linkedStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies the number format for the specified list level. + * For EACH ITEM in the collection: Specifies the number format for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberFormat?: 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 the position (in points) of the number or bullet for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberPosition?: boolean; /** - * For EACH ITEM in the collection: Specifies the number style for the list level object. + * For EACH ITEM in the collection: Specifies the number style for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ numberStyle?: 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 list level that must appear before it restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ resetOnHigher?: 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 starting number for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ startAt?: 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 tab position for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ tabPosition?: 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 position (in points) for the second line of wrapping text for the `ListLevel` object. * * @remarks * [Api set: WordApiDesktop 1.1] */ textPosition?: 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: Specifies the character inserted after the number for the list level. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -135312,18 +135661,18 @@ declare namespace Word { */ $all?: boolean; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ reference?: Word.Interfaces.RangeLoadOptions; /** * Represents the note item type: footnote or endnote. @@ -135345,18 +135694,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ reference?: Word.Interfaces.RangeLoadOptions; /** * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. @@ -135400,7 +135749,7 @@ declare namespace Word { width?: boolean; } /** - * Represents the collection of page. + * Represents the collection of {@link Word.Page} objects. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -135444,98 +135793,98 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ list?: Word.Interfaces.ListLoadOptions; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItem?: Word.Interfaces.ListItemLoadOptions; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * Gets the parent body of the paragraph. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the paragraph. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.1] @@ -135666,98 +136015,98 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ list?: Word.Interfaces.ListLoadOptions; /** - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItem?: Word.Interfaces.ListItemLoadOptions; /** - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the paragraph. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the paragraph. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.1] @@ -135998,74 +136347,74 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * Gets the parent body of the range. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Specifies the proofing status (spelling and grammar checking) of the range. @@ -136150,74 +136499,74 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the range. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. @@ -136303,49 +136652,49 @@ declare namespace Word { */ $all?: boolean; /** - * 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. + * If provided, specifies whether to ignore all punctuation characters between words. The default is `false`. Corresponds to the _Ignore punctuation characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignorePunct?: boolean; /** - * 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. + * If provided, specifies whether to ignore all whitespace between words. The default is `false`. Corresponds to the _Ignore white-space characters_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ ignoreSpace?: boolean; /** - * 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. + * If provided, specifies whether to perform a case sensitive search. The default is `false`. Corresponds to the _Match case_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchCase?: boolean; /** - * 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. + * If provided, specifies whether to match words that begin with the search string. The default is `false`. Corresponds to the _Match prefix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchPrefix?: boolean; /** - * 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. + * If provided, specifies whether to match words that end with the search string. The default is `false`. Corresponds to the _Match suffix_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchSuffix?: boolean; /** - * 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. + * If provided, specifies whether to find only entire words, not text that's part of a larger word. The default is `false`. Corresponds to the _Find whole words only_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] */ matchWholeWord?: boolean; /** - * 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. + * If provided, specifies whether the search will be performed using special search operators. The default is `false`. Corresponds to the _Use wildcards_ check box in the **Find and Replace** dialog box. * * @remarks * [Api set: WordApi 1.1] @@ -136364,18 +136713,18 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** * Specifies if the section is protected for forms. @@ -136397,18 +136746,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata. - * - * @remarks - * [Api set: WordApi 1.1] - */ + * For EACH ITEM in the collection: Gets the `Body` object of the section. This doesn't include the header, footer, and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** * For EACH ITEM in the collection: Specifies if the section is protected for forms. @@ -136482,60 +136831,60 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Specifies a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * For EACH ITEM in the collection: Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderCollectionLoadOptions; /** - * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frame?: Word.Interfaces.FrameLoadOptions; /** - * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * For EACH ITEM in the collection: Gets a `ListTemplate` object that represents the list formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * For EACH ITEM in the collection: Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * For EACH ITEM in the collection: Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingLoadOptions; /** - * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * For EACH ITEM in the collection: Gets a `TableStyle` object representing style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** * For EACH ITEM in the collection: Specifies whether the style is automatically redefined based on the selection. @@ -136554,7 +136903,7 @@ declare namespace Word { */ baseStyle?: boolean; /** - * For EACH ITEM in the collection: Gets whether the specified style is a built-in style. + * For EACH ITEM in the collection: Gets whether the style is a built-in style. * * @remarks * [Api set: WordApi 1.5] @@ -136568,7 +136917,7 @@ declare namespace Word { */ hasProofing?: boolean; /** - * For EACH ITEM in the collection: 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. + * For EACH ITEM in the collection: Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks * [Api set: WordApi 1.5] @@ -136589,7 +136938,7 @@ declare namespace Word { */ languageIdFarEast?: boolean; /** - * For EACH ITEM in the collection: Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * For EACH ITEM in the collection: Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks * [Api set: WordApi 1.5] @@ -136610,14 +136959,14 @@ declare namespace Word { */ locked?: boolean; /** - * For EACH ITEM in the collection: Gets the name of a style in the language of the user. + * For EACH ITEM in the collection: Gets the name of the style in the language of the user. * * @remarks * [Api set: WordApi 1.5] */ nameLocal?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks * [Api set: WordApi 1.5] @@ -136654,14 +137003,14 @@ declare namespace Word { */ type?: boolean; /** - * For EACH ITEM in the collection: 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. + * For EACH ITEM in the collection: Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks * [Api set: WordApi 1.5] */ unhideWhenUsed?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * For EACH ITEM in the collection: Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] @@ -136680,60 +137029,60 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Specifies a `BorderCollection` object that represents all the borders for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ borders?: Word.Interfaces.BorderCollectionLoadOptions; /** - * Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `Font` object that represents the character formatting of the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Returns a `Frame` object that represents the frame formatting for the style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ frame?: Word.Interfaces.FrameLoadOptions; /** - * Specifies a link between a paragraph and a character style. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ + * Gets a `ListTemplate` object that represents the list formatting for the style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ + * Gets a `ParagraphFormat` object that represents the paragraph settings for the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a `Shading` object that represents the shading for the style. Not applicable to a style of `List` type. + * + * @remarks + * [Api set: WordApi 1.6] + */ shading?: Word.Interfaces.ShadingLoadOptions; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. - * - * @remarks - * [Api set: WordApi 1.6] - */ + * Gets a `TableStyle` object representing style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** * Specifies whether the style is automatically redefined based on the selection. @@ -136752,7 +137101,7 @@ declare namespace Word { */ baseStyle?: boolean; /** - * Gets whether the specified style is a built-in style. + * Gets whether the style is a built-in style. * * @remarks * [Api set: WordApi 1.5] @@ -136766,7 +137115,7 @@ declare namespace Word { */ hasProofing?: boolean; /** - * 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. + * Gets whether the style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks * [Api set: WordApi 1.5] @@ -136787,7 +137136,7 @@ declare namespace Word { */ languageIdFarEast?: boolean; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets whether the style is a linked style that can be used for both paragraph and character formatting. * * @remarks * [Api set: WordApi 1.5] @@ -136808,14 +137157,14 @@ declare namespace Word { */ locked?: boolean; /** - * Gets the name of a style in the language of the user. + * Gets the name of the style in the language of the user. * * @remarks * [Api set: WordApi 1.5] */ nameLocal?: 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 name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the style. * * @remarks * [Api set: WordApi 1.5] @@ -136852,14 +137201,14 @@ declare namespace Word { */ type?: 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. + * Specifies whether the style is made visible as a recommended style in the Styles gallery and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks * [Api set: WordApi 1.5] */ unhideWhenUsed?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies whether the style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] @@ -136867,7 +137216,7 @@ declare namespace Word { visibility?: boolean; } /** - * Represents the shading object. + * Represents the `Shading` object. * * @remarks * [Api set: WordApi 1.6] @@ -136958,63 +137307,63 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent body of the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApi 1.3] @@ -137028,7 +137377,7 @@ declare namespace Word { */ headerRowCount?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * 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] @@ -137119,7 +137468,7 @@ declare namespace Word { */ values?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -137134,7 +137483,7 @@ declare namespace Word { width?: boolean; } /** - * Represents the TableStyle object. + * Represents the `TableStyle` object. * * @remarks * [Api set: WordApi 1.6] @@ -137152,7 +137501,7 @@ declare namespace Word { */ alignment?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies whether lines in tables formatted with a style break across pages. * * @remarks * [Api set: WordApiDesktop 1.1] @@ -137195,7 +137544,7 @@ declare namespace Word { topCellMargin?: boolean; } /** - * Contains the collection of the document's Table objects. + * Contains the collection of the document's {@link Word.Table} objects. * * @remarks * [Api set: WordApi 1.3] @@ -137206,63 +137555,63 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent body of the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be `left`, `centered`, or `right`. * * @remarks * [Api set: WordApi 1.3] @@ -137276,7 +137625,7 @@ declare namespace Word { */ headerRowCount?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -137367,7 +137716,7 @@ declare namespace Word { */ values?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -137393,11 +137742,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Returns the position of this column in a collection. @@ -137462,11 +137811,11 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the column. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Returns the position of this column in a collection. @@ -137531,18 +137880,18 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * Gets parent table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** * Gets the number of cells in the row. @@ -137552,14 +137901,14 @@ declare namespace Word { */ cellCount?: boolean; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] */ horizontalAlignment?: boolean; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks * [Api set: WordApi 1.3] @@ -137594,7 +137943,7 @@ declare namespace Word { */ values?: boolean; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -137602,7 +137951,7 @@ declare namespace Word { verticalAlignment?: boolean; } /** - * Contains the collection of the document's TableRow objects. + * Contains the collection of the document's {@link Word.TableRow} objects. * * @remarks * [Api set: WordApi 1.3] @@ -137613,18 +137962,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets parent table. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** * For EACH ITEM in the collection: Gets the number of cells in the row. @@ -137634,14 +137983,14 @@ declare namespace Word { */ cellCount?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the row. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] */ horizontalAlignment?: boolean; /** - * For EACH ITEM in the collection: Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * For EACH ITEM in the collection: Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the `Table` object. * * @remarks * [Api set: WordApi 1.3] @@ -137676,7 +138025,7 @@ declare namespace Word { */ values?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * For EACH ITEM in the collection: Specifies the vertical alignment of the cells in the row. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -137695,25 +138044,25 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the parent row of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent row of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentRow?: Word.Interfaces.TableRowLoadOptions; /** - * Gets the parent table of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * Gets the parent table of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** * Gets the index of the cell in its row. @@ -137730,7 +138079,7 @@ declare namespace Word { */ columnWidth?: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -137758,7 +138107,7 @@ declare namespace Word { */ value?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -137773,7 +138122,7 @@ declare namespace Word { width?: boolean; } /** - * Contains the collection of the document's TableCell objects. + * Contains the collection of the document's {@link Word.TableCell} objects. * * @remarks * [Api set: WordApi 1.3] @@ -137784,25 +138133,25 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Gets the body object of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the `Body` object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent row of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent row of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentRow?: Word.Interfaces.TableRowLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent table of the cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ + * For EACH ITEM in the collection: Gets the parent table of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ parentTable?: Word.Interfaces.TableLoadOptions; /** * For EACH ITEM in the collection: Gets the index of the cell in its row. @@ -137819,7 +138168,7 @@ declare namespace Word { */ columnWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * For EACH ITEM in the collection: Specifies the horizontal alignment of the cell. The value can be `left`, `centered`, `right`, or `justified`. * * @remarks * [Api set: WordApi 1.3] @@ -137847,7 +138196,7 @@ declare namespace Word { */ value?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * For EACH ITEM in the collection: Specifies the vertical alignment of the cell. The value can be `top`, `center`, or `bottom`. * * @remarks * [Api set: WordApi 1.3] @@ -138208,60 +138557,60 @@ declare namespace Word { */ $all?: boolean; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ canvas?: Word.Interfaces.CanvasLoadOptions; /** - * Returns the fill formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the fill formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ fill?: Word.Interfaces.ShapeFillLoadOptions; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentCanvas?: Word.Interfaces.ShapeLoadOptions; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentGroup?: Word.Interfaces.ShapeLoadOptions; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; /** - * Gets the text frame object of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `TextFrame` object of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textFrame?: Word.Interfaces.TextFrameLoadOptions; /** - * Returns the text wrap formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; /** * Specifies whether a given shape can overlap other shapes. @@ -138419,7 +138768,7 @@ declare namespace Word { widthRelative?: boolean; } /** - * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. + * Represents a shape group in the document. To get the corresponding {@link Word.Shape} object, use `ShapeGroup.shape`. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -138430,11 +138779,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the Shape object associated with the group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeLoadOptions; /** * Gets an integer that represents the shape group identifier. @@ -138445,7 +138794,7 @@ declare namespace Word { id?: boolean; } /** - * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * Represents a canvas in the document. To get the corresponding {@link Word.Shape} object, use `Canvas.shape`. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -138456,11 +138805,11 @@ declare namespace Word { */ $all?: boolean; /** - * Gets the Shape object associated with the canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * Gets the `Shape` object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shape?: Word.Interfaces.ShapeLoadOptions; /** * Gets an integer that represents the canvas identifier. @@ -138482,60 +138831,60 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ body?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `canvas`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ canvas?: Word.Interfaces.CanvasLoadOptions; /** - * For EACH ITEM in the collection: Returns the fill formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Returns the fill formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ fill?: Word.Interfaces.ShapeFillLoadOptions; /** - * For EACH ITEM in the collection: Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentCanvas?: Word.Interfaces.ShapeLoadOptions; /** - * For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ parentGroup?: Word.Interfaces.ShapeLoadOptions; /** - * For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't `groupShape`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions; /** - * For EACH ITEM in the collection: Gets the text frame object of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Gets the `TextFrame` object of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textFrame?: Word.Interfaces.TextFrameLoadOptions; /** - * For EACH ITEM in the collection: Returns the text wrap formatting of the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ + * For EACH ITEM in the collection: Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions; /** * For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes. @@ -138693,7 +139042,7 @@ declare namespace Word { widthRelative?: boolean; } /** - * Represents the fill formatting of a shape object. + * Represents the fill formatting of a {@link Word.Shape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -138733,7 +139082,7 @@ declare namespace Word { type?: boolean; } /** - * Represents the text frame of a shape object. + * Represents the text frame of a {@link Word.Shape} object. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -138744,63 +139093,63 @@ declare namespace Word { */ $all?: 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. + * Specifies the automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks * [Api set: WordApiDesktop 1.2] */ autoSizeSetting?: boolean; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the bottom margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ bottomMargin?: boolean; /** - * Specifies if the text frame contains text. + * Returns `true` if the text frame contains text, otherwise, `false`. * * @remarks * [Api set: WordApiDesktop 1.2] */ hasText?: boolean; /** - * Represents the left margin, in points, of the text frame. + * Specifies the left margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ leftMargin?: boolean; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. * * @remarks * [Api set: WordApiDesktop 1.2] */ noTextRotation?: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks * [Api set: WordApiDesktop 1.2] */ orientation?: boolean; /** - * Represents the right margin, in points, of the text frame. + * Specifies the right margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ rightMargin?: boolean; /** - * Represents the top margin, in points, of the text frame. + * Specifies the top margin, in points, of the text frame. * * @remarks * [Api set: WordApiDesktop 1.2] */ topMargin?: boolean; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -138815,7 +139164,7 @@ declare namespace Word { wordWrap?: boolean; } /** - * Represents all the properties for wrapping text around a shape. + * Represents all the properties for wrapping text around a {@link Word.Shape}. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -138880,11 +139229,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns the range of this repeating section item, excluding the start and end tags. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; } /** @@ -138899,25 +139248,25 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** * Specifies the appearance of the content control. @@ -139030,25 +139379,25 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** * Specifies the appearance of the content control. @@ -139133,25 +139482,25 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** * Specifies the appearance of the content control. @@ -139236,25 +139585,25 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Returns a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** * Specifies the appearance of the content control. @@ -139353,18 +139702,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. @@ -139463,18 +139812,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Specifies the height (in points) of the frame. @@ -139573,18 +139922,18 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Specifies the height (in points) of the frame. @@ -139749,18 +140098,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ list?: Word.Interfaces.ListLoadOptions; /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** * Indicates whether the `ListFormat` object contains a single list. @@ -139817,18 +140166,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the background color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. @@ -139986,11 +140335,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color for a glow effect. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ color?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the length of the radius for a glow effect. @@ -140020,18 +140369,18 @@ declare namespace Word { */ $all?: boolean; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the length of the arrowhead at the beginning of the line. @@ -140231,11 +140580,11 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. @@ -140323,18 +140672,18 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ contourColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ extrusionColor?: Word.Interfaces.ColorFormatLoadOptions; /** * Specifies the depth of the bottom bevel. @@ -140611,11 +140960,11 @@ declare namespace Word { */ $all?: boolean; /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. - * - * @remarks - * [Api set: WordApiDesktop 1.3] - */ + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * + * @remarks + * [Api set: WordApiDesktop 1.3] + */ lineNumbering?: Word.Interfaces.LineNumberingLoadOptions; /** * Specifies whether Microsoft Word prints the document as a booklet.