@types/office-js-preview 1.0.430 → 1.0.432

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -89057,23 +89057,20 @@ declare namespace Word {
89057
89057
  createDocument(base64File?: string): Word.DocumentCreated;
89058
89058
  /**
89059
89059
  * Opens a document and displays it in a new tab or window.
89060
+ The following are examples for the various supported clients and platforms.
89061
+
89062
+ - Remote or cloud location example: `https://microsoft.sharepoint.com/some/path/Document.docx`
89063
+
89064
+ - Local location examples for Windows: `C:\\Users\\Someone\\Documents\\Document.docx` (includes required escaped backslashes), `file://mycomputer/myfolder/Document.docx`
89065
+
89066
+ - Local location example for Mac and iOS: `/User/someone/document.docx`
89060
89067
  *
89061
89068
  * @remarks
89062
- * [Api set: WordApi BETA (PREVIEW ONLY)]
89063
- *
89064
- * The following are examples for the various supported clients and platforms.
89065
- *
89066
- * - Remote or cloud location example: `https://microsoft.sharepoint.com/some/path/Document.docx`
89067
- *
89068
- * - Local location examples for Windows: `C:\\Users\\Someone\\Documents\\Document.docx` (includes required escaped backslashes), `file://mycomputer/myfolder/Document.docx`
89069
- *
89070
- * - Local location example for Mac and iOS: `/User/someone/document.docx`
89069
+ * [Api set: WordApi 1.6]
89071
89070
  *
89072
- * @beta
89073
- *
89074
- * @param fileLocation Required. The absolute location of the .docx file. Word on the web only supports remote (cloud) locations, while Word on Windows, Mac, and iOS support local and remote locations.
89071
+ * @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.
89075
89072
  */
89076
- openDocument(fileLocation: string): void;
89073
+ openDocument(filePath: string): void;
89077
89074
  /**
89078
89075
  * Parse styles from template Base64 file and return JSON format of retrieved styles as a string.
89079
89076
  *
@@ -89140,7 +89137,7 @@ declare namespace Word {
89140
89137
  */
89141
89138
  readonly footnotes: Word.NoteItemCollection;
89142
89139
  /**
89143
- * Gets the collection of InlinePicture objects in the body. The collection does not include floating images.
89140
+ * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
89144
89141
  *
89145
89142
  * @remarks
89146
89143
  * [Api set: WordApi 1.1]
@@ -89154,10 +89151,12 @@ declare namespace Word {
89154
89151
  */
89155
89152
  readonly lists: Word.ListCollection;
89156
89153
  /**
89157
- * Gets the collection of paragraph objects in the body. **Important**: Paragraphs in tables are not returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned.
89154
+ * Gets the collection of paragraph objects in the body.
89158
89155
  *
89159
89156
  * @remarks
89160
89157
  * [Api set: WordApi 1.1]
89158
+ *
89159
+ * 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.
89161
89160
  */
89162
89161
  readonly paragraphs: Word.ParagraphCollection;
89163
89162
  /**
@@ -89260,18 +89259,20 @@ declare namespace Word {
89260
89259
  */
89261
89260
  getComments(): Word.CommentCollection;
89262
89261
  /**
89263
- * Gets the currently supported content controls in the body. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
89264
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
89265
- With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
89262
+ * Gets the currently supported content controls in the body.
89266
89263
  *
89267
89264
  * @remarks
89268
89265
  * [Api set: WordApi 1.5]
89269
89266
  *
89267
+ * Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
89268
+ * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
89269
+ * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
89270
+ *
89270
89271
  * @param options Optional. Options that define which content controls are returned.
89271
89272
  */
89272
89273
  getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
89273
89274
  /**
89274
- * 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 does not 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.
89275
+ * 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.
89275
89276
  *
89276
89277
  * @remarks
89277
89278
  * [Api set: WordApi 1.1]
@@ -89315,8 +89316,7 @@ declare namespace Word {
89315
89316
  * Gets the collection of the TrackedChange objects in the body.
89316
89317
  *
89317
89318
  * @remarks
89318
- * [Api set: WordApi BETA (PREVIEW ONLY)]
89319
- * @beta
89319
+ * [Api set: WordApi 1.6]
89320
89320
  */
89321
89321
  getTrackedChanges(): Word.TrackedChangeCollection;
89322
89322
  /**
@@ -89546,45 +89546,45 @@ declare namespace Word {
89546
89546
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
89547
89547
  context: RequestContext;
89548
89548
  /**
89549
- * Specifies the line color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
89549
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
89550
89550
  *
89551
89551
  * @remarks
89552
89552
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89553
89553
  * @beta
89554
89554
  */
89555
- lineColor: string;
89555
+ color: string;
89556
89556
  /**
89557
- * Specifies the line style for the border.
89557
+ * Gets the location of the border.
89558
89558
  *
89559
89559
  * @remarks
89560
89560
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89561
89561
  * @beta
89562
89562
  */
89563
- lineStyle: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
89563
+ readonly location: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";
89564
89564
  /**
89565
- * Specifies the line width for the border.
89565
+ * Specifies the border type for the border.
89566
89566
  *
89567
89567
  * @remarks
89568
89568
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89569
89569
  * @beta
89570
89570
  */
89571
- lineWidth: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
89571
+ type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
89572
89572
  /**
89573
- * Gets the position type of the border.
89573
+ * Specifies whether the border is visible.
89574
89574
  *
89575
89575
  * @remarks
89576
89576
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89577
89577
  * @beta
89578
89578
  */
89579
- readonly positionType: Word.BorderPositionType | "Top" | "Left" | "Bottom" | "Right" | "Horizontal" | "Vertical" | "DiagonalDown" | "DiagonalUp";
89579
+ visible: boolean;
89580
89580
  /**
89581
- * Specifies whether the border is visible.
89581
+ * Specifies the width for the border.
89582
89582
  *
89583
89583
  * @remarks
89584
89584
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89585
89585
  * @beta
89586
89586
  */
89587
- visible: boolean;
89587
+ width: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
89588
89588
  /**
89589
89589
  * 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.
89590
89590
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
@@ -89641,69 +89641,61 @@ declare namespace Word {
89641
89641
  /** Gets the loaded child items in this collection. */
89642
89642
  readonly items: Word.Border[];
89643
89643
  /**
89644
- * Specifies the 24-bit color of the inside borders.
89645
- *
89646
- * @remarks
89647
- * [Api set: WordApi BETA (PREVIEW ONLY)]
89648
- * @beta
89649
- */
89650
- insideLineColor: string;
89651
- /**
89652
- * Specifies the line style of the inside borders.
89644
+ * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
89653
89645
  *
89654
89646
  * @remarks
89655
89647
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89656
89648
  * @beta
89657
89649
  */
89658
- insideLineStyle: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
89650
+ insideBorderColor: string;
89659
89651
  /**
89660
- * Specifies the line width of the inside borders.
89652
+ * Specifies the border type of the inside borders.
89661
89653
  *
89662
89654
  * @remarks
89663
89655
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89664
89656
  * @beta
89665
89657
  */
89666
- insideLineWidth: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
89658
+ insideBorderType: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
89667
89659
  /**
89668
- * Specifies the 24-bit color of the outside borders.
89660
+ * Specifies the width of the inside borders.
89669
89661
  *
89670
89662
  * @remarks
89671
89663
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89672
89664
  * @beta
89673
89665
  */
89674
- outsideLineColor: string;
89666
+ insideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
89675
89667
  /**
89676
- * Specifies the line style of the outside borders.
89668
+ * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
89677
89669
  *
89678
89670
  * @remarks
89679
89671
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89680
89672
  * @beta
89681
89673
  */
89682
- outsideLineStyle: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
89674
+ outsideBorderColor: string;
89683
89675
  /**
89684
- * Specifies the line width of the outside borders.
89676
+ * Specifies the border type of the outside borders.
89685
89677
  *
89686
89678
  * @remarks
89687
89679
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89688
89680
  * @beta
89689
89681
  */
89690
- outsideLineWidth: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
89682
+ outsideBorderType: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
89691
89683
  /**
89692
- * Gets the border that has the specified position type.
89684
+ * Specifies the width of the outside borders.
89693
89685
  *
89694
89686
  * @remarks
89695
89687
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89696
89688
  * @beta
89697
89689
  */
89698
- getByPositionType(positionType: Word.BorderPositionType): Word.Border;
89690
+ outsideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
89699
89691
  /**
89700
- * Gets the border that has the specified position type.
89692
+ * Gets the border that has the specified location.
89701
89693
  *
89702
89694
  * @remarks
89703
89695
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89704
89696
  * @beta
89705
89697
  */
89706
- getByPositionType(positionType: "Top" | "Left" | "Bottom" | "Right" | "Horizontal" | "Vertical" | "DiagonalDown" | "DiagonalUp"): Word.Border;
89698
+ getByLocation(borderLocation: Word.BorderLocation.top | Word.BorderLocation.left | Word.BorderLocation.bottom | Word.BorderLocation.right | Word.BorderLocation.insideHorizontal | Word.BorderLocation.insideVertical | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical"): Word.Border;
89707
89699
  /**
89708
89700
  * Gets the first border in this collection. Throws an `ItemNotFound` error if this collection is empty.
89709
89701
  *
@@ -89769,7 +89761,9 @@ declare namespace Word {
89769
89761
  * [Api set: WordApi BETA (PREVIEW ONLY)]
89770
89762
  * @beta
89771
89763
  */
89772
- interface CheckboxContentControl {
89764
+ class CheckboxContentControl extends OfficeExtension.ClientObject {
89765
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
89766
+ context: RequestContext;
89773
89767
  /**
89774
89768
  * Specifies the current state of the checkbox.
89775
89769
  *
@@ -89778,6 +89772,40 @@ declare namespace Word {
89778
89772
  * @beta
89779
89773
  */
89780
89774
  isChecked: boolean;
89775
+ /**
89776
+ * 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.
89777
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
89778
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
89779
+ */
89780
+ set(properties: Interfaces.CheckboxContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;
89781
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
89782
+ set(properties: Word.CheckboxContentControl): void;
89783
+ /**
89784
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
89785
+ *
89786
+ * @param options Provides options for which properties of the object to load.
89787
+ */
89788
+ load(options?: Word.Interfaces.CheckboxContentControlLoadOptions): Word.CheckboxContentControl;
89789
+ /**
89790
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
89791
+ *
89792
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
89793
+ */
89794
+ load(propertyNames?: string | string[]): Word.CheckboxContentControl;
89795
+ /**
89796
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
89797
+ *
89798
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
89799
+ */
89800
+ load(propertyNamesAndPaths?: {
89801
+ select?: string;
89802
+ expand?: string;
89803
+ }): Word.CheckboxContentControl;
89804
+ /**
89805
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
89806
+ * 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.
89807
+ */
89808
+ toJSON(): Word.Interfaces.CheckboxContentControlData;
89781
89809
  }
89782
89810
  /**
89783
89811
  * Represents a comment in the document.
@@ -90017,7 +90045,7 @@ declare namespace Word {
90017
90045
  */
90018
90046
  readonly text: string;
90019
90047
  /**
90020
- * Specifies a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
90048
+ * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
90021
90049
  *
90022
90050
  * @remarks
90023
90051
  * [Api set: WordApi 1.4]
@@ -90250,6 +90278,14 @@ declare namespace Word {
90250
90278
  class ContentControl extends OfficeExtension.ClientObject {
90251
90279
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
90252
90280
  context: RequestContext;
90281
+ /**
90282
+ * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
90283
+ *
90284
+ * @remarks
90285
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
90286
+ * @beta
90287
+ */
90288
+ readonly checkboxContentControl: Word.CheckboxContentControl;
90253
90289
  /**
90254
90290
  * Gets the collection of content control objects in the content control.
90255
90291
  *
@@ -90286,7 +90322,7 @@ declare namespace Word {
90286
90322
  */
90287
90323
  readonly footnotes: Word.NoteItemCollection;
90288
90324
  /**
90289
- * Gets the collection of InlinePicture objects in the content control. The collection does not include floating images.
90325
+ * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images.
90290
90326
  *
90291
90327
  * @remarks
90292
90328
  * [Api set: WordApi 1.1]
@@ -90300,10 +90336,12 @@ declare namespace Word {
90300
90336
  */
90301
90337
  readonly lists: Word.ListCollection;
90302
90338
  /**
90303
- * Gets the collection of paragraph objects in the content control. **Important**: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control are not returned. From requirement set 1.3, paragraphs in such tables are also returned.
90339
+ * Gets the collection of paragraph objects in the content control.
90304
90340
  *
90305
90341
  * @remarks
90306
90342
  * [Api set: WordApi 1.1]
90343
+ *
90344
+ * 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.
90307
90345
  */
90308
90346
  readonly paragraphs: Word.ParagraphCollection;
90309
90347
  /**
@@ -90328,14 +90366,14 @@ declare namespace Word {
90328
90366
  */
90329
90367
  readonly parentContentControlOrNullObject: Word.ContentControl;
90330
90368
  /**
90331
- * Gets the table that contains the content control. Throws an `ItemNotFound` error if it is not contained in a table.
90369
+ * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
90332
90370
  *
90333
90371
  * @remarks
90334
90372
  * [Api set: WordApi 1.3]
90335
90373
  */
90336
90374
  readonly parentTable: Word.Table;
90337
90375
  /**
90338
- * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it is not contained in a table cell.
90376
+ * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
90339
90377
  *
90340
90378
  * @remarks
90341
90379
  * [Api set: WordApi 1.3]
@@ -90383,14 +90421,6 @@ declare namespace Word {
90383
90421
  * [Api set: WordApi 1.1]
90384
90422
  */
90385
90423
  cannotEdit: boolean;
90386
- /**
90387
- * Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
90388
- *
90389
- * @remarks
90390
- * [Api set: WordApi BETA (PREVIEW ONLY)]
90391
- * @beta
90392
- */
90393
- readonly checkboxContentControl: Word.CheckboxContentControl;
90394
90424
  /**
90395
90425
  * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
90396
90426
  *
@@ -90406,7 +90436,9 @@ declare namespace Word {
90406
90436
  */
90407
90437
  readonly id: number;
90408
90438
  /**
90409
- * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. **Note**: The set operation for this property is not supported in Word on the web.
90439
+ * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
90440
+
90441
+ Note: The set operation for this property isn't supported in Word on the web.
90410
90442
  *
90411
90443
  * @remarks
90412
90444
  * [Api set: WordApi 1.1]
@@ -90484,12 +90516,12 @@ declare namespace Word {
90484
90516
  */
90485
90517
  clear(): void;
90486
90518
  /**
90487
- * Deletes the content control and its content. If keepContent is set to true, the content is not deleted.
90519
+ * Deletes the content control and its content. If `keepContent` is set to true, the content isn't deleted.
90488
90520
  *
90489
90521
  * @remarks
90490
90522
  * [Api set: WordApi 1.1]
90491
90523
  *
90492
- * @param keepContent Required. Indicates whether the content should be deleted with the content control. If keepContent is set to true, the content is not deleted.
90524
+ * @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.
90493
90525
  */
90494
90526
  delete(keepContent: boolean): void;
90495
90527
  /**
@@ -90500,18 +90532,20 @@ declare namespace Word {
90500
90532
  */
90501
90533
  getComments(): Word.CommentCollection;
90502
90534
  /**
90503
- * Gets the currently supported child content controls in this content control. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
90504
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
90505
- With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
90535
+ * Gets the currently supported child content controls in this content control.
90506
90536
  *
90507
90537
  * @remarks
90508
90538
  * [Api set: WordApi 1.5]
90509
90539
  *
90540
+ * Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
90541
+ * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
90542
+ * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
90543
+ *
90510
90544
  * @param options Optional. Options that define which content controls are returned.
90511
90545
  */
90512
90546
  getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
90513
90547
  /**
90514
- * 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 does not 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.
90548
+ * 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.
90515
90549
  *
90516
90550
  * @remarks
90517
90551
  * [Api set: WordApi 1.1]
@@ -90565,8 +90599,7 @@ declare namespace Word {
90565
90599
  * Gets the collection of the TrackedChange objects in the content control.
90566
90600
  *
90567
90601
  * @remarks
90568
- * [Api set: WordApi BETA (PREVIEW ONLY)]
90569
- * @beta
90602
+ * [Api set: WordApi 1.6]
90570
90603
  */
90571
90604
  getTrackedChanges(): Word.TrackedChangeCollection;
90572
90605
  /**
@@ -91073,7 +91106,7 @@ declare namespace Word {
91073
91106
  */
91074
91107
  getCount(): OfficeExtension.ClientResult<number>;
91075
91108
  /**
91076
- * Gets a custom property object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property does not exist.
91109
+ * Gets a custom property object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property doesn't exist.
91077
91110
  *
91078
91111
  * @remarks
91079
91112
  * [Api set: WordApi 1.3]
@@ -91174,7 +91207,7 @@ declare namespace Word {
91174
91207
  * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
91175
91208
  *
91176
91209
  * @param xpath Required. Absolute path to the single element in XPath notation.
91177
- * @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 does not used reserved XPath characters, such as the forward slash "/".
91210
+ * @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 "/".
91178
91211
  * @param name Required. Name of the attribute.
91179
91212
  */
91180
91213
  deleteAttribute(xpath: string, namespaceMappings: {
@@ -91202,7 +91235,7 @@ declare namespace Word {
91202
91235
  * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
91203
91236
  *
91204
91237
  * @param xpath Required. Absolute path to the single element in XPath notation.
91205
- * @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 does not used reserved XPath characters, such as the forward slash "/".
91238
+ * @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 "/".
91206
91239
  */
91207
91240
  deleteElement(xpath: string, namespaceMappings: {
91208
91241
  [key: string]: string;
@@ -91236,7 +91269,7 @@ declare namespace Word {
91236
91269
  * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
91237
91270
  *
91238
91271
  * @param xpath Required. Absolute path to the single element in XPath notation.
91239
- * @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 does not used reserved XPath characters, such as the forward slash "/".
91272
+ * @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 "/".
91240
91273
  * @param name Required. Name of the attribute.
91241
91274
  * @param value Required. Value of the attribute.
91242
91275
  */
@@ -91266,7 +91299,7 @@ declare namespace Word {
91266
91299
  *
91267
91300
  * @param xpath Required. Absolute path to the single parent element in XPath notation.
91268
91301
  * @param xml Required. XML content to be inserted.
91269
- * @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 does not used reserved XPath characters, such as the forward slash "/".
91302
+ * @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 "/".
91270
91303
  * @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.
91271
91304
  */
91272
91305
  insertElement(xpath: string, xml: string, namespaceMappings: {
@@ -91294,7 +91327,7 @@ declare namespace Word {
91294
91327
  * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
91295
91328
  *
91296
91329
  * @param xpath Required. An XPath query.
91297
- * @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 does not used reserved XPath characters, such as the forward slash "/".
91330
+ * @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 "/".
91298
91331
  * @returns An array where each item represents an entry matched by the XPath query.
91299
91332
  */
91300
91333
  query(xpath: string, namespaceMappings: {
@@ -91331,7 +91364,7 @@ declare namespace Word {
91331
91364
  * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter.
91332
91365
  *
91333
91366
  * @param xpath Required. Absolute path to the single element in XPath notation.
91334
- * @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 does not used reserved XPath characters, such as the forward slash "/".
91367
+ * @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 "/".
91335
91368
  * @param name Required. Name of the attribute.
91336
91369
  * @param value Required. New value of the attribute.
91337
91370
  */
@@ -91361,7 +91394,7 @@ declare namespace Word {
91361
91394
  *
91362
91395
  * @param xpath Required. Absolute path to the single element in XPath notation.
91363
91396
  * @param xml Required. New XML content to be stored.
91364
- * @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 does not used reserved XPath characters, such as the forward slash "/".
91397
+ * @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 "/".
91365
91398
  */
91366
91399
  updateElement(xpath: string, xml: string, namespaceMappings: {
91367
91400
  [key: string]: string;
@@ -91663,7 +91696,7 @@ declare namespace Word {
91663
91696
  */
91664
91697
  addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;
91665
91698
  /**
91666
- * Close current document.
91699
+ * Closes the current document.
91667
91700
  *
91668
91701
  * @remarks
91669
91702
  * [Api set: WordApi 1.5]
@@ -91672,7 +91705,7 @@ declare namespace Word {
91672
91705
  */
91673
91706
  close(closeBehavior?: Word.CloseBehavior): void;
91674
91707
  /**
91675
- * Close current document.
91708
+ * Closes the current document.
91676
91709
  *
91677
91710
  * @remarks
91678
91711
  * [Api set: WordApi 1.5]
@@ -91697,7 +91730,7 @@ declare namespace Word {
91697
91730
  * @remarks
91698
91731
  * [Api set: WordApi 1.4]
91699
91732
  *
91700
- * @param name Required. The bookmark name, which is case-insensitive.
91733
+ * @param name Required. The case-insensitive bookmark name.
91701
91734
  */
91702
91735
  deleteBookmark(name: string): void;
91703
91736
  /**
@@ -91711,12 +91744,12 @@ declare namespace Word {
91711
91744
  */
91712
91745
  getAnnotationById(id: string): Word.Annotation;
91713
91746
  /**
91714
- * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark does not exist.
91747
+ * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist.
91715
91748
  *
91716
91749
  * @remarks
91717
91750
  * [Api set: WordApi 1.4]
91718
91751
  *
91719
- * @param name Required. The bookmark name, which is case-insensitive.
91752
+ * @param name Required. The case-insensitive bookmark name.
91720
91753
  */
91721
91754
  getBookmarkRange(name: string): Word.Range;
91722
91755
  /**
@@ -91725,17 +91758,19 @@ declare namespace Word {
91725
91758
  * @remarks
91726
91759
  * [Api set: WordApi 1.4]
91727
91760
  *
91728
- * @param name Required. The bookmark name, which is case-insensitive.
91761
+ * @param name Required. The case-insensitive bookmark name.
91729
91762
  */
91730
91763
  getBookmarkRangeOrNullObject(name: string): Word.Range;
91731
91764
  /**
91732
- * Gets the currently supported content controls in the document. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
91733
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
91734
- With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
91765
+ * Gets the currently supported content controls in the document.
91735
91766
  *
91736
91767
  * @remarks
91737
91768
  * [Api set: WordApi 1.5]
91738
91769
  *
91770
+ * Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
91771
+ * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
91772
+ * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
91773
+ *
91739
91774
  * @param options Optional. Options that define which content controls are returned.
91740
91775
  */
91741
91776
  getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
@@ -91759,14 +91794,13 @@ declare namespace Word {
91759
91794
  * Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty.
91760
91795
  *
91761
91796
  * @remarks
91762
- * [Api set: WordApi BETA (PREVIEW ONLY)]
91763
- * @beta
91797
+ * [Api set: WordApi 1.6]
91764
91798
  *
91765
91799
  * @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.
91766
91800
  */
91767
91801
  getParagraphByUniqueLocalId(id: string): Word.Paragraph;
91768
91802
  /**
91769
- * Gets the current selection of the document. Multiple selections are not supported.
91803
+ * Gets the current selection of the document. Multiple selections aren't supported.
91770
91804
  *
91771
91805
  * @remarks
91772
91806
  * [Api set: WordApi 1.1]
@@ -91783,8 +91817,7 @@ declare namespace Word {
91783
91817
  * Import styles from a JSON-formatted string.
91784
91818
  *
91785
91819
  * @remarks
91786
- * [Api set: WordApi BETA (PREVIEW ONLY)]
91787
- * @beta
91820
+ * [Api set: WordApi 1.6]
91788
91821
  *
91789
91822
  * @param stylesJson Required. A JSON-formatted string representing the styles.
91790
91823
  */
@@ -91916,30 +91949,27 @@ declare namespace Word {
91916
91949
  * Occurs when the user adds new paragraphs.
91917
91950
  *
91918
91951
  * @remarks
91919
- * [Api set: WordApi BETA (PREVIEW ONLY)]
91952
+ * [Api set: WordApi 1.6]
91920
91953
  *
91921
91954
  * @eventproperty
91922
- * @beta
91923
91955
  */
91924
91956
  readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;
91925
91957
  /**
91926
91958
  * Occurs when the user changes paragraphs.
91927
91959
  *
91928
91960
  * @remarks
91929
- * [Api set: WordApi BETA (PREVIEW ONLY)]
91961
+ * [Api set: WordApi 1.6]
91930
91962
  *
91931
91963
  * @eventproperty
91932
- * @beta
91933
91964
  */
91934
91965
  readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;
91935
91966
  /**
91936
91967
  * Occurs when the user deletes paragraphs.
91937
91968
  *
91938
91969
  * @remarks
91939
- * [Api set: WordApi BETA (PREVIEW ONLY)]
91970
+ * [Api set: WordApi 1.6]
91940
91971
  *
91941
91972
  * @eventproperty
91942
- * @beta
91943
91973
  */
91944
91974
  readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;
91945
91975
  /**
@@ -92048,16 +92078,16 @@ declare namespace Word {
92048
92078
  * @remarks
92049
92079
  * [Api set: WordApiHiddenDocument 1.4]
92050
92080
  *
92051
- * @param name Required. The bookmark name, which is case-insensitive.
92081
+ * @param name Required. The case-insensitive bookmark name.
92052
92082
  */
92053
92083
  deleteBookmark(name: string): void;
92054
92084
  /**
92055
- * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark does not exist.
92085
+ * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist.
92056
92086
  *
92057
92087
  * @remarks
92058
92088
  * [Api set: WordApiHiddenDocument 1.4]
92059
92089
  *
92060
- * @param name Required. The bookmark name, which is case-insensitive.
92090
+ * @param name Required. The case-insensitive bookmark name.
92061
92091
  */
92062
92092
  getBookmarkRange(name: string): Word.Range;
92063
92093
  /**
@@ -92066,17 +92096,19 @@ declare namespace Word {
92066
92096
  * @remarks
92067
92097
  * [Api set: WordApiHiddenDocument 1.4]
92068
92098
  *
92069
- * @param name Required. The bookmark name, which is case-insensitive.
92099
+ * @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.
92070
92100
  */
92071
92101
  getBookmarkRangeOrNullObject(name: string): Word.Range;
92072
92102
  /**
92073
- * Gets the currently supported content controls in the document. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
92074
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
92075
- With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
92103
+ * Gets the currently supported content controls in the document.
92076
92104
  *
92077
92105
  * @remarks
92078
92106
  * [Api set: WordApiHiddenDocument 1.5]
92079
92107
  *
92108
+ * Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
92109
+ * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
92110
+ * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
92111
+ *
92080
92112
  * @param options Optional. Options that define which content controls are returned.
92081
92113
  */
92082
92114
  getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
@@ -92378,14 +92410,14 @@ declare namespace Word {
92378
92410
  */
92379
92411
  readonly parentContentControlOrNullObject: Word.ContentControl;
92380
92412
  /**
92381
- * Gets the table that contains the field. Throws an `ItemNotFound` error if it is not contained in a table.
92413
+ * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
92382
92414
  *
92383
92415
  * @remarks
92384
92416
  * [Api set: WordApi 1.4]
92385
92417
  */
92386
92418
  readonly parentTable: Word.Table;
92387
92419
  /**
92388
- * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it is not contained in a table cell.
92420
+ * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
92389
92421
  *
92390
92422
  * @remarks
92391
92423
  * [Api set: WordApi 1.4]
@@ -92702,7 +92734,7 @@ declare namespace Word {
92702
92734
  */
92703
92735
  superscript: boolean;
92704
92736
  /**
92705
- * Specifies a value that indicates the font's underline type. 'None' if the font is not underlined.
92737
+ * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
92706
92738
  *
92707
92739
  * @remarks
92708
92740
  * [Api set: WordApi 1.1]
@@ -92782,14 +92814,14 @@ declare namespace Word {
92782
92814
  */
92783
92815
  readonly parentContentControlOrNullObject: Word.ContentControl;
92784
92816
  /**
92785
- * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it is not contained in a table.
92817
+ * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
92786
92818
  *
92787
92819
  * @remarks
92788
92820
  * [Api set: WordApi 1.3]
92789
92821
  */
92790
92822
  readonly parentTable: Word.Table;
92791
92823
  /**
92792
- * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it is not contained in a table cell.
92824
+ * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
92793
92825
  *
92794
92826
  * @remarks
92795
92827
  * [Api set: WordApi 1.3]
@@ -93445,7 +93477,7 @@ declare namespace Word {
93445
93477
  /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
93446
93478
  set(properties: Word.ListItem): void;
93447
93479
  /**
93448
- * Gets the list item parent, or the closest ancestor if the parent does not exist. Throws an `ItemNotFound` error if the list item has no ancestor.
93480
+ * Gets the list item parent, or the closest ancestor if the parent doesn't exist. Throws an `ItemNotFound` error if the list item has no ancestor.
93449
93481
  *
93450
93482
  * @remarks
93451
93483
  * [Api set: WordApi 1.3]
@@ -93972,21 +94004,21 @@ declare namespace Word {
93972
94004
  */
93973
94005
  readonly footnotes: Word.NoteItemCollection;
93974
94006
  /**
93975
- * Gets the collection of InlinePicture objects in the paragraph. The collection does not include floating images.
94007
+ * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
93976
94008
  *
93977
94009
  * @remarks
93978
94010
  * [Api set: WordApi 1.1]
93979
94011
  */
93980
94012
  readonly inlinePictures: Word.InlinePictureCollection;
93981
94013
  /**
93982
- * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph is not in a list.
94014
+ * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
93983
94015
  *
93984
94016
  * @remarks
93985
94017
  * [Api set: WordApi 1.3]
93986
94018
  */
93987
94019
  readonly list: Word.List;
93988
94020
  /**
93989
- * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph is not part of a list.
94021
+ * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
93990
94022
  *
93991
94023
  * @remarks
93992
94024
  * [Api set: WordApi 1.3]
@@ -94028,14 +94060,14 @@ declare namespace Word {
94028
94060
  */
94029
94061
  readonly parentContentControlOrNullObject: Word.ContentControl;
94030
94062
  /**
94031
- * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it is not contained in a table.
94063
+ * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
94032
94064
  *
94033
94065
  * @remarks
94034
94066
  * [Api set: WordApi 1.3]
94035
94067
  */
94036
94068
  readonly parentTable: Word.Table;
94037
94069
  /**
94038
- * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it is not contained in a table cell.
94070
+ * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
94039
94071
  *
94040
94072
  * @remarks
94041
94073
  * [Api set: WordApi 1.3]
@@ -94154,7 +94186,7 @@ declare namespace Word {
94154
94186
  */
94155
94187
  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";
94156
94188
  /**
94157
- * Gets the level of the paragraph's table. It returns 0 if the paragraph is not in a table.
94189
+ * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
94158
94190
  *
94159
94191
  * @remarks
94160
94192
  * [Api set: WordApi 1.3]
@@ -94171,8 +94203,7 @@ declare namespace Word {
94171
94203
  * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
94172
94204
  *
94173
94205
  * @remarks
94174
- * [Api set: WordApi BETA (PREVIEW ONLY)]
94175
- * @beta
94206
+ * [Api set: WordApi 1.6]
94176
94207
  */
94177
94208
  readonly uniqueLocalId: string;
94178
94209
  /**
@@ -94230,18 +94261,20 @@ declare namespace Word {
94230
94261
  */
94231
94262
  getComments(): Word.CommentCollection;
94232
94263
  /**
94233
- * Gets the currently supported content controls in the paragraph. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
94234
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
94235
- With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
94264
+ * Gets the currently supported content controls in the paragraph.
94236
94265
  *
94237
94266
  * @remarks
94238
94267
  * [Api set: WordApi 1.5]
94239
94268
  *
94269
+ * Important: If specific types are provided in the options parameter, only content controls of supported types are returned.
94270
+ * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
94271
+ * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
94272
+ *
94240
94273
  * @param options Optional. Options that define which content controls are returned.
94241
94274
  */
94242
94275
  getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
94243
94276
  /**
94244
- * 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 does not 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.
94277
+ * 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.
94245
94278
  *
94246
94279
  * @remarks
94247
94280
  * [Api set: WordApi 1.1]
@@ -94309,6 +94342,20 @@ declare namespace Word {
94309
94342
  * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'.
94310
94343
  */
94311
94344
  getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
94345
+ /**
94346
+ * Returns the text of the paragraph. This excludes equations, graphics (e.g., images, videos, drawings), and special characters that mark various content (e.g., for content controls, fields, comments, footnotes, endnotes).
94347
+ By default, hidden text and text marked as deleted are excluded.
94348
+ *
94349
+ * @remarks
94350
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
94351
+ * @beta
94352
+ *
94353
+ * @param options Optional. Options that define whether the final result should include hidden text and text marked as deleted.
94354
+ */
94355
+ getText(options?: Word.GetTextOptions | {
94356
+ IncludeHiddenText?: boolean;
94357
+ IncludeTextMarkedAsDeleted?: boolean;
94358
+ }): OfficeExtension.ClientResult<string>;
94312
94359
  /**
94313
94360
  * Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.
94314
94361
  *
@@ -94323,8 +94370,7 @@ declare namespace Word {
94323
94370
  * Gets the collection of the TrackedChange objects in the paragraph.
94324
94371
  *
94325
94372
  * @remarks
94326
- * [Api set: WordApi BETA (PREVIEW ONLY)]
94327
- * @beta
94373
+ * [Api set: WordApi 1.6]
94328
94374
  */
94329
94375
  getTrackedChanges(): Word.TrackedChangeCollection;
94330
94376
  /**
@@ -94852,10 +94898,12 @@ declare namespace Word {
94852
94898
  */
94853
94899
  readonly lists: Word.ListCollection;
94854
94900
  /**
94855
- * Gets the collection of paragraph objects in the range. **Important**: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range are not returned. From requirement set 1.3, paragraphs in such tables are also returned.
94901
+ * Gets the collection of paragraph objects in the range.
94856
94902
  *
94857
94903
  * @remarks
94858
94904
  * [Api set: WordApi 1.1]
94905
+ *
94906
+ * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range aren't returned. From requirement set 1.3, paragraphs in such tables are also returned.
94859
94907
  */
94860
94908
  readonly paragraphs: Word.ParagraphCollection;
94861
94909
  /**
@@ -94880,14 +94928,14 @@ declare namespace Word {
94880
94928
  */
94881
94929
  readonly parentContentControlOrNullObject: Word.ContentControl;
94882
94930
  /**
94883
- * Gets the table that contains the range. Throws an `ItemNotFound` error if it is not contained in a table.
94931
+ * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
94884
94932
  *
94885
94933
  * @remarks
94886
94934
  * [Api set: WordApi 1.3]
94887
94935
  */
94888
94936
  readonly parentTable: Word.Table;
94889
94937
  /**
94890
- * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it is not contained in a table cell.
94938
+ * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
94891
94939
  *
94892
94940
  * @remarks
94893
94941
  * [Api set: WordApi 1.3]
@@ -94981,7 +95029,7 @@ declare namespace Word {
94981
95029
  */
94982
95030
  delete(): void;
94983
95031
  /**
94984
- * Returns a new range that extends from this range in either direction to cover another range. This range is not changed. Throws an `ItemNotFound` error if the two ranges do not have a union.
95032
+ * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges do not have a union.
94985
95033
  *
94986
95034
  * @remarks
94987
95035
  * [Api set: WordApi 1.3]
@@ -95017,18 +95065,20 @@ declare namespace Word {
95017
95065
  */
95018
95066
  getComments(): Word.CommentCollection;
95019
95067
  /**
95020
- * Gets the currently supported content controls in the range. **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
95021
- Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
95022
- With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
95068
+ * Gets the currently supported content controls in the range.
95023
95069
  *
95024
95070
  * @remarks
95025
95071
  * [Api set: WordApi 1.5]
95026
95072
  *
95073
+ * **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned.
95074
+ * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type.
95075
+ * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls.
95076
+ *
95027
95077
  * @param options Optional. Options that define which content controls are returned.
95028
95078
  */
95029
95079
  getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
95030
95080
  /**
95031
- * 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 does not 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.
95081
+ * 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.
95032
95082
  *
95033
95083
  * @remarks
95034
95084
  * [Api set: WordApi 1.1]
@@ -95109,8 +95159,7 @@ declare namespace Word {
95109
95159
  * Gets the collection of the TrackedChange objects in the range.
95110
95160
  *
95111
95161
  * @remarks
95112
- * [Api set: WordApi BETA (PREVIEW ONLY)]
95113
- * @beta
95162
+ * [Api set: WordApi 1.6]
95114
95163
  */
95115
95164
  getTrackedChanges(): Word.TrackedChangeCollection;
95116
95165
  /**
@@ -95300,7 +95349,7 @@ declare namespace Word {
95300
95349
  */
95301
95350
  insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;
95302
95351
  /**
95303
- * Returns a new range as the intersection of this range with another range. This range is not changed. Throws an `ItemNotFound` error if the two ranges are not overlapped or adjacent.
95352
+ * Returns a new range as the intersection of this range with another range. This range isn't changed. Throws an `ItemNotFound` error if the two ranges aren't overlapped or adjacent.
95304
95353
  *
95305
95354
  * @remarks
95306
95355
  * [Api set: WordApi 1.3]
@@ -95515,16 +95564,14 @@ declare namespace Word {
95515
95564
  * Represents whether the custom properties from the source document should be imported. Overwrites existing properties with the same name.
95516
95565
  *
95517
95566
  * @remarks
95518
- * [Api set: WordApi BETA (PREVIEW ONLY)]
95519
- * @beta
95567
+ * [Api set: WordApi 1.6]
95520
95568
  */
95521
95569
  importCustomProperties?: boolean;
95522
95570
  /**
95523
95571
  * Represents whether the custom XML parts from the source document should be imported.
95524
95572
  *
95525
95573
  * @remarks
95526
- * [Api set: WordApi BETA (PREVIEW ONLY)]
95527
- * @beta
95574
+ * [Api set: WordApi 1.6]
95528
95575
  */
95529
95576
  importCustomXmlParts?: boolean;
95530
95577
  /**
@@ -95654,6 +95701,31 @@ declare namespace Word {
95654
95701
  */
95655
95702
  toJSON(): Word.Interfaces.SearchOptionsData;
95656
95703
  }
95704
+ /**
95705
+ * Specifies the options to be included in a getText operation.
95706
+ *
95707
+ * @remarks
95708
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
95709
+ * @beta
95710
+ */
95711
+ interface GetTextOptions {
95712
+ /**
95713
+ * Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False.
95714
+ *
95715
+ * @remarks
95716
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
95717
+ * @beta
95718
+ */
95719
+ includeHiddenText?: boolean;
95720
+ /**
95721
+ * Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False.
95722
+ *
95723
+ * @remarks
95724
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
95725
+ * @beta
95726
+ */
95727
+ includeTextMarkedAsDeleted?: boolean;
95728
+ }
95657
95729
  /**
95658
95730
  * Specifies the options to be included in a compare document operation.
95659
95731
  *
@@ -95730,7 +95802,7 @@ declare namespace Word {
95730
95802
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
95731
95803
  context: RequestContext;
95732
95804
  /**
95733
- * Gets the body object of the section. This does not include the header/footer and other section metadata.
95805
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
95734
95806
  *
95735
95807
  * @remarks
95736
95808
  * [Api set: WordApi 1.1]
@@ -95995,7 +96067,7 @@ declare namespace Word {
95995
96067
  */
95996
96068
  getCount(): OfficeExtension.ClientResult<number>;
95997
96069
  /**
95998
- * Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting does not exist.
96070
+ * Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist.
95999
96071
  *
96000
96072
  * @remarks
96001
96073
  * [Api set: WordApi 1.4]
@@ -96164,25 +96236,25 @@ declare namespace Word {
96164
96236
  * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
96165
96237
  *
96166
96238
  * @remarks
96167
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96168
- * @beta
96239
+ * [Api set: WordApi 1.6]
96169
96240
  */
96170
96241
  readonly shading: Word.Shading;
96171
96242
  /**
96172
96243
  * Gets a TableStyle object representing Style properties that can be applied to a table.
96173
96244
  *
96174
96245
  * @remarks
96175
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96176
- * @beta
96246
+ * [Api set: WordApi 1.6]
96177
96247
  */
96178
96248
  readonly tableStyle: Word.TableStyle;
96179
96249
  /**
96180
- * Gets the name of an existing style to use as the base formatting of another style.
96250
+ * Specifies the name of an existing style to use as the base formatting of another style.
96181
96251
  *
96182
96252
  * @remarks
96183
96253
  * [Api set: WordApi 1.5]
96254
+ *
96255
+ * Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
96184
96256
  */
96185
- readonly baseStyle: string;
96257
+ baseStyle: string;
96186
96258
  /**
96187
96259
  * Gets whether the specified style is a built-in style.
96188
96260
  *
@@ -96220,12 +96292,14 @@ declare namespace Word {
96220
96292
  */
96221
96293
  readonly nameLocal: string;
96222
96294
  /**
96223
- * Gets the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.
96295
+ * 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.
96224
96296
  *
96225
96297
  * @remarks
96226
96298
  * [Api set: WordApi 1.5]
96299
+ *
96300
+ * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
96227
96301
  */
96228
- readonly nextParagraphStyle: string;
96302
+ nextParagraphStyle: string;
96229
96303
  /**
96230
96304
  * Specifies the priority.
96231
96305
  *
@@ -96315,8 +96389,7 @@ declare namespace Word {
96315
96389
  * Represents the shading object.
96316
96390
  *
96317
96391
  * @remarks
96318
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96319
- * @beta
96392
+ * [Api set: WordApi 1.6]
96320
96393
  */
96321
96394
  class Shading extends OfficeExtension.ClientObject {
96322
96395
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -96325,8 +96398,7 @@ declare namespace Word {
96325
96398
  * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
96326
96399
  *
96327
96400
  * @remarks
96328
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96329
- * @beta
96401
+ * [Api set: WordApi 1.6]
96330
96402
  */
96331
96403
  backgroundPatternColor: string;
96332
96404
  /**
@@ -96447,14 +96519,14 @@ declare namespace Word {
96447
96519
  */
96448
96520
  readonly parentContentControlOrNullObject: Word.ContentControl;
96449
96521
  /**
96450
- * Gets the table that contains this table. Throws an `ItemNotFound` error if it is not contained in a table.
96522
+ * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
96451
96523
  *
96452
96524
  * @remarks
96453
96525
  * [Api set: WordApi 1.3]
96454
96526
  */
96455
96527
  readonly parentTable: Word.Table;
96456
96528
  /**
96457
- * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it is not contained in a table cell.
96529
+ * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
96458
96530
  *
96459
96531
  * @remarks
96460
96532
  * [Api set: WordApi 1.3]
@@ -96704,7 +96776,7 @@ declare namespace Word {
96704
96776
  */
96705
96777
  getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;
96706
96778
  /**
96707
- * Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell does not exist.
96779
+ * Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell doesn't exist.
96708
96780
  *
96709
96781
  * @remarks
96710
96782
  * [Api set: WordApi 1.3]
@@ -96928,8 +97000,7 @@ declare namespace Word {
96928
97000
  * Represents the TableStyle object.
96929
97001
  *
96930
97002
  * @remarks
96931
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96932
- * @beta
97003
+ * [Api set: WordApi 1.6]
96933
97004
  */
96934
97005
  class TableStyle extends OfficeExtension.ClientObject {
96935
97006
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -96954,40 +97025,35 @@ declare namespace Word {
96954
97025
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
96955
97026
  *
96956
97027
  * @remarks
96957
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96958
- * @beta
97028
+ * [Api set: WordApi 1.6]
96959
97029
  */
96960
97030
  bottomCellMargin: number;
96961
97031
  /**
96962
97032
  * Specifies the spacing (in points) between the cells in a table style.
96963
97033
  *
96964
97034
  * @remarks
96965
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96966
- * @beta
97035
+ * [Api set: WordApi 1.6]
96967
97036
  */
96968
97037
  cellSpacing: number;
96969
97038
  /**
96970
97039
  * Specifies the amount of space to add between the contents and the left borders of the cells.
96971
97040
  *
96972
97041
  * @remarks
96973
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96974
- * @beta
97042
+ * [Api set: WordApi 1.6]
96975
97043
  */
96976
97044
  leftCellMargin: number;
96977
97045
  /**
96978
97046
  * Specifies the amount of space to add between the contents and the right borders of the cells.
96979
97047
  *
96980
97048
  * @remarks
96981
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96982
- * @beta
97049
+ * [Api set: WordApi 1.6]
96983
97050
  */
96984
97051
  rightCellMargin: number;
96985
97052
  /**
96986
97053
  * Specifies the amount of space to add between the contents and the top borders of the cells.
96987
97054
  *
96988
97055
  * @remarks
96989
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96990
- * @beta
97056
+ * [Api set: WordApi 1.6]
96991
97057
  */
96992
97058
  topCellMargin: number;
96993
97059
  /**
@@ -97822,82 +97888,72 @@ declare namespace Word {
97822
97888
  * Represents a tracked change in a Word document.
97823
97889
  *
97824
97890
  * @remarks
97825
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97826
- * @beta
97891
+ * [Api set: WordApi 1.6]
97827
97892
  */
97828
97893
  class TrackedChange extends OfficeExtension.ClientObject {
97829
97894
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
97830
97895
  context: RequestContext;
97831
97896
  /**
97832
- * Specifies the author of the tracked change.
97897
+ * Gets the author of the tracked change.
97833
97898
  *
97834
97899
  * @remarks
97835
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97836
- * @beta
97900
+ * [Api set: WordApi 1.6]
97837
97901
  */
97838
97902
  readonly author: string;
97839
97903
  /**
97840
- * Specifies the date of the tracked change.
97904
+ * Gets the date of the tracked change.
97841
97905
  *
97842
97906
  * @remarks
97843
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97844
- * @beta
97907
+ * [Api set: WordApi 1.6]
97845
97908
  */
97846
97909
  readonly date: Date;
97847
97910
  /**
97848
- * Specifies the text of the tracked change.
97911
+ * Gets the text of the tracked change.
97849
97912
  *
97850
97913
  * @remarks
97851
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97852
- * @beta
97914
+ * [Api set: WordApi 1.6]
97853
97915
  */
97854
97916
  readonly text: string;
97855
97917
  /**
97856
- * Specifies the type of the tracked change.
97918
+ * Gets the type of the tracked change.
97857
97919
  *
97858
97920
  * @remarks
97859
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97860
- * @beta
97921
+ * [Api set: WordApi 1.6]
97861
97922
  */
97862
97923
  readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";
97863
97924
  /**
97864
97925
  * Accepts the tracked change.
97865
97926
  *
97866
97927
  * @remarks
97867
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97868
- * @beta
97928
+ * [Api set: WordApi 1.6]
97869
97929
  */
97870
97930
  accept(): void;
97871
97931
  /**
97872
97932
  * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one.
97873
97933
  *
97874
97934
  * @remarks
97875
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97876
- * @beta
97935
+ * [Api set: WordApi 1.6]
97877
97936
  */
97878
97937
  getNext(): Word.TrackedChange;
97879
97938
  /**
97880
97939
  * Gets the next tracked change. If this tracked change is the last one, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
97881
97940
  *
97882
97941
  * @remarks
97883
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97884
- * @beta
97942
+ * [Api set: WordApi 1.6]
97885
97943
  */
97886
97944
  getNextOrNullObject(): Word.TrackedChange;
97887
97945
  /**
97888
97946
  * Gets the range of the tracked change.
97889
97947
  *
97890
97948
  * @remarks
97891
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97892
- * @beta
97949
+ * [Api set: WordApi 1.6]
97893
97950
  */
97894
97951
  getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;
97895
97952
  /**
97896
97953
  * Rejects the tracked change.
97897
97954
  *
97898
97955
  * @remarks
97899
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97900
- * @beta
97956
+ * [Api set: WordApi 1.6]
97901
97957
  */
97902
97958
  reject(): void;
97903
97959
  /**
@@ -97939,8 +97995,7 @@ declare namespace Word {
97939
97995
  * Contains a collection of {@link Word.TrackedChange} objects.
97940
97996
  *
97941
97997
  * @remarks
97942
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97943
- * @beta
97998
+ * [Api set: WordApi 1.6]
97944
97999
  */
97945
98000
  class TrackedChangeCollection extends OfficeExtension.ClientObject {
97946
98001
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -97951,50 +98006,28 @@ declare namespace Word {
97951
98006
  * Accepts all the tracked changes in the collection.
97952
98007
  *
97953
98008
  * @remarks
97954
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97955
- * @beta
98009
+ * [Api set: WordApi 1.6]
97956
98010
  */
97957
98011
  acceptAll(): void;
97958
- /**
97959
- * Gets the number of TrackedChange objects in the collection.
97960
- *
97961
- * @remarks
97962
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97963
- * @beta
97964
- */
97965
- getCount(): OfficeExtension.ClientResult<number>;
97966
98012
  /**
97967
98013
  * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty.
97968
98014
  *
97969
98015
  * @remarks
97970
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97971
- * @beta
98016
+ * [Api set: WordApi 1.6]
97972
98017
  */
97973
98018
  getFirst(): Word.TrackedChange;
97974
98019
  /**
97975
98020
  * Gets the first TrackedChange in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
97976
98021
  *
97977
98022
  * @remarks
97978
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97979
- * @beta
98023
+ * [Api set: WordApi 1.6]
97980
98024
  */
97981
98025
  getFirstOrNullObject(): Word.TrackedChange;
97982
- /**
97983
- * Gets a TrackedChange object by its index in the collection.
97984
- *
97985
- * @remarks
97986
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97987
- * @beta
97988
- *
97989
- * @param index A number that identifies the index location of a TrackedChange object.
97990
- */
97991
- getItem(index: number): Word.TrackedChange;
97992
98026
  /**
97993
98027
  * Rejects all the tracked changes in the collection.
97994
98028
  *
97995
98029
  * @remarks
97996
- * [Api set: WordApi BETA (PREVIEW ONLY)]
97997
- * @beta
98030
+ * [Api set: WordApi 1.6]
97998
98031
  */
97999
98032
  rejectAll(): void;
98000
98033
  /**
@@ -98105,36 +98138,31 @@ declare namespace Word {
98105
98138
  * TrackedChange type.
98106
98139
  *
98107
98140
  * @remarks
98108
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98109
- * @beta
98141
+ * [Api set: WordApi 1.6]
98110
98142
  */
98111
98143
  enum TrackedChangeType {
98112
98144
  /**
98113
98145
  * No revision.
98114
98146
  * @remarks
98115
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98116
- * @beta
98147
+ * [Api set: WordApi 1.6]
98117
98148
  */
98118
98149
  none = "None",
98119
98150
  /**
98120
98151
  * Add change.
98121
98152
  * @remarks
98122
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98123
- * @beta
98153
+ * [Api set: WordApi 1.6]
98124
98154
  */
98125
98155
  added = "Added",
98126
98156
  /**
98127
98157
  * Delete change.
98128
98158
  * @remarks
98129
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98130
- * @beta
98159
+ * [Api set: WordApi 1.6]
98131
98160
  */
98132
98161
  deleted = "Deleted",
98133
98162
  /**
98134
98163
  * Format change.
98135
98164
  * @remarks
98136
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98137
- * @beta
98165
+ * [Api set: WordApi 1.6]
98138
98166
  */
98139
98167
  formatted = "Formatted",
98140
98168
  }
@@ -98237,22 +98265,19 @@ declare namespace Word {
98237
98265
  /**
98238
98266
  * Represents that one or more new paragraphs were added.
98239
98267
  * @remarks
98240
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98241
- * @beta
98268
+ * [Api set: WordApi 1.6]
98242
98269
  */
98243
98270
  paragraphAdded = "ParagraphAdded",
98244
98271
  /**
98245
98272
  * Represents that one or more paragraphs were changed.
98246
98273
  * @remarks
98247
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98248
- * @beta
98274
+ * [Api set: WordApi 1.6]
98249
98275
  */
98250
98276
  paragraphChanged = "ParagraphChanged",
98251
98277
  /**
98252
98278
  * Represents that one or more paragraphs were deleted.
98253
98279
  * @remarks
98254
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98255
- * @beta
98280
+ * [Api set: WordApi 1.6]
98256
98281
  */
98257
98282
  paragraphDeleted = "ParagraphDeleted",
98258
98283
  /**
@@ -98521,32 +98546,28 @@ declare namespace Word {
98521
98546
  * Provides information about the paragraphs that raised the paragraphAdded event.
98522
98547
  *
98523
98548
  * @remarks
98524
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98525
- * @beta
98549
+ * [Api set: WordApi 1.6]
98526
98550
  */
98527
98551
  interface ParagraphAddedEventArgs {
98528
98552
  /**
98529
98553
  * The source of the event. It can be local or remote (through coauthoring).
98530
98554
  *
98531
98555
  * @remarks
98532
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98533
- * @beta
98556
+ * [Api set: WordApi 1.6]
98534
98557
  */
98535
98558
  source: Word.EventSource | "Local" | "Remote";
98536
98559
  /**
98537
98560
  * The event type. See Word.EventType for details.
98538
98561
  *
98539
98562
  * @remarks
98540
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98541
- * @beta
98563
+ * [Api set: WordApi 1.6]
98542
98564
  */
98543
98565
  type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
98544
98566
  /**
98545
98567
  * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
98546
98568
  *
98547
98569
  * @remarks
98548
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98549
- * @beta
98570
+ * [Api set: WordApi 1.6]
98550
98571
  */
98551
98572
  uniqueLocalIds: string[];
98552
98573
  }
@@ -98554,32 +98575,28 @@ declare namespace Word {
98554
98575
  * Provides information about the paragraphs that raised the paragraphChanged event.
98555
98576
  *
98556
98577
  * @remarks
98557
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98558
- * @beta
98578
+ * [Api set: WordApi 1.6]
98559
98579
  */
98560
98580
  interface ParagraphChangedEventArgs {
98561
98581
  /**
98562
98582
  * The source of the event. It can be local or remote (through coauthoring).
98563
98583
  *
98564
98584
  * @remarks
98565
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98566
- * @beta
98585
+ * [Api set: WordApi 1.6]
98567
98586
  */
98568
98587
  source: Word.EventSource | "Local" | "Remote";
98569
98588
  /**
98570
98589
  * The event type. See Word.EventType for details.
98571
98590
  *
98572
98591
  * @remarks
98573
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98574
- * @beta
98592
+ * [Api set: WordApi 1.6]
98575
98593
  */
98576
98594
  type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
98577
98595
  /**
98578
98596
  * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
98579
98597
  *
98580
98598
  * @remarks
98581
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98582
- * @beta
98599
+ * [Api set: WordApi 1.6]
98583
98600
  */
98584
98601
  uniqueLocalIds: string[];
98585
98602
  }
@@ -98587,32 +98604,28 @@ declare namespace Word {
98587
98604
  * Provides information about the paragraphs that raised the paragraphDeleted event.
98588
98605
  *
98589
98606
  * @remarks
98590
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98591
- * @beta
98607
+ * [Api set: WordApi 1.6]
98592
98608
  */
98593
98609
  interface ParagraphDeletedEventArgs {
98594
98610
  /**
98595
98611
  * The source of the event. It can be local or remote (through coauthoring).
98596
98612
  *
98597
98613
  * @remarks
98598
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98599
- * @beta
98614
+ * [Api set: WordApi 1.6]
98600
98615
  */
98601
98616
  source: Word.EventSource | "Local" | "Remote";
98602
98617
  /**
98603
98618
  * The event type. See Word.EventType for details.
98604
98619
  *
98605
98620
  * @remarks
98606
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98607
- * @beta
98621
+ * [Api set: WordApi 1.6]
98608
98622
  */
98609
98623
  type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved";
98610
98624
  /**
98611
98625
  * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors.
98612
98626
  *
98613
98627
  * @remarks
98614
- * [Api set: WordApi BETA (PREVIEW ONLY)]
98615
- * @beta
98628
+ * [Api set: WordApi 1.6]
98616
98629
  */
98617
98630
  uniqueLocalIds: string[];
98618
98631
  }
@@ -98859,7 +98872,7 @@ declare namespace Word {
98859
98872
  */
98860
98873
  tags = "Tags",
98861
98874
  /**
98862
- * Represents a content control that is not shown.
98875
+ * Represents a content control that isn't shown.
98863
98876
  * @remarks
98864
98877
  * [Api set: WordApi 1.1]
98865
98878
  */
@@ -99364,13 +99377,13 @@ declare namespace Word {
99364
99377
  */
99365
99378
  equal = "Equal",
99366
99379
  /**
99367
- * Indicates that this instance contains the range and that it shares the same start character. The range does not share the same end character as this instance.
99380
+ * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance.
99368
99381
  * @remarks
99369
99382
  * [Api set: WordApi 1.3]
99370
99383
  */
99371
99384
  containsStart = "ContainsStart",
99372
99385
  /**
99373
- * Indicates that this instance contains the range and that it shares the same end character. The range does not share the same start character as this instance.
99386
+ * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance.
99374
99387
  * @remarks
99375
99388
  * [Api set: WordApi 1.3]
99376
99389
  */
@@ -99382,19 +99395,19 @@ declare namespace Word {
99382
99395
  */
99383
99396
  contains = "Contains",
99384
99397
  /**
99385
- * Indicates that this instance is inside the range and that it shares the same start character. The range does not share the same end character as this instance.
99398
+ * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance.
99386
99399
  * @remarks
99387
99400
  * [Api set: WordApi 1.3]
99388
99401
  */
99389
99402
  insideStart = "InsideStart",
99390
99403
  /**
99391
- * Indicates that this instance is inside the range and that it shares the same end character. The range does not share the same start character as this instance.
99404
+ * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance.
99392
99405
  * @remarks
99393
99406
  * [Api set: WordApi 1.3]
99394
99407
  */
99395
99408
  insideEnd = "InsideEnd",
99396
99409
  /**
99397
- * Indicates that this instance is inside the range. The range does not share the same start and end characters as this instance.
99410
+ * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance.
99398
99411
  * @remarks
99399
99412
  * [Api set: WordApi 1.3]
99400
99413
  */
@@ -99406,7 +99419,7 @@ declare namespace Word {
99406
99419
  */
99407
99420
  adjacentBefore = "AdjacentBefore",
99408
99421
  /**
99409
- * Indicates that this instance starts before the range and overlaps the ranges first character.
99422
+ * Indicates that this instance starts before the range and overlaps the range's first character.
99410
99423
  * @remarks
99411
99424
  * [Api set: WordApi 1.3]
99412
99425
  */
@@ -99514,267 +99527,76 @@ declare namespace Word {
99514
99527
  right = "Right",
99515
99528
  }
99516
99529
  /**
99517
- * Represents the line style for the specified border.
99530
+ * Represents the width of a style's border.
99518
99531
  *
99519
99532
  * @remarks
99520
99533
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99521
99534
  * @beta
99522
99535
  */
99523
- enum LineStyle {
99536
+ enum BorderWidth {
99524
99537
  /**
99525
- * Represents the dash-dot line style.
99538
+ * None width.
99526
99539
  * @remarks
99527
99540
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99528
99541
  * @beta
99529
99542
  */
99530
- dashDot = "DashDot",
99543
+ none = "None",
99531
99544
  /**
99532
- * Represents the dash-dot-dot line style.
99545
+ * 0.25 point.
99533
99546
  * @remarks
99534
99547
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99535
99548
  * @beta
99536
99549
  */
99537
- dashDotDot = "DashDotDot",
99550
+ pt025 = "Pt025",
99538
99551
  /**
99539
- * Represents the dash-dot-stroked line style.
99552
+ * 0.50 point.
99540
99553
  * @remarks
99541
99554
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99542
99555
  * @beta
99543
99556
  */
99544
- dashDotStroked = "DashDotStroked",
99557
+ pt050 = "Pt050",
99545
99558
  /**
99546
- * Represents the line style of dashes with large gaps.
99559
+ * 0.75 point.
99547
99560
  * @remarks
99548
99561
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99549
99562
  * @beta
99550
99563
  */
99551
- dashLargeGap = "DashLargeGap",
99564
+ pt075 = "Pt075",
99552
99565
  /**
99553
- * Represents the line style of dashes with small gaps.
99566
+ * 1.00 point. This is the default.
99554
99567
  * @remarks
99555
99568
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99556
99569
  * @beta
99557
99570
  */
99558
- dashSmallGap = "DashSmallGap",
99571
+ pt100 = "Pt100",
99559
99572
  /**
99560
- * Represents the dot line style.
99573
+ * 1.50 points.
99561
99574
  * @remarks
99562
99575
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99563
99576
  * @beta
99564
99577
  */
99565
- dot = "Dot",
99578
+ pt150 = "Pt150",
99566
99579
  /**
99567
- * Represents the double line style.
99580
+ * 2.25 points.
99568
99581
  * @remarks
99569
99582
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99570
99583
  * @beta
99571
99584
  */
99572
- double = "Double",
99585
+ pt225 = "Pt225",
99573
99586
  /**
99574
- * Represents the double-wavy line style.
99587
+ * 3.00 points.
99575
99588
  * @remarks
99576
99589
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99577
99590
  * @beta
99578
99591
  */
99579
- doubleWavy = "DoubleWavy",
99592
+ pt300 = "Pt300",
99580
99593
  /**
99581
- * Represents the emboss-3D line style.
99594
+ * 4.50 points.
99582
99595
  * @remarks
99583
99596
  * [Api set: WordApi BETA (PREVIEW ONLY)]
99584
99597
  * @beta
99585
99598
  */
99586
- emboss3D = "Emboss3D",
99587
- /**
99588
- * Represents the engrave-3D line style.
99589
- * @remarks
99590
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99591
- * @beta
99592
- */
99593
- engrave3D = "Engrave3D",
99594
- /**
99595
- * Represents the inset line style.
99596
- * @remarks
99597
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99598
- * @beta
99599
- */
99600
- inset = "Inset",
99601
- /**
99602
- * Mixed line style.
99603
- * @remarks
99604
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99605
- * @beta
99606
- */
99607
- mixed = "Mixed",
99608
- /**
99609
- * Represents that there's no line style.
99610
- * @remarks
99611
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99612
- * @beta
99613
- */
99614
- none = "None",
99615
- /**
99616
- * Represents the outset line style.
99617
- * @remarks
99618
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99619
- * @beta
99620
- */
99621
- outset = "Outset",
99622
- /**
99623
- * Represents the single line style.
99624
- * @remarks
99625
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99626
- * @beta
99627
- */
99628
- single = "Single",
99629
- /**
99630
- * Represents the single-wavy line style.
99631
- * @remarks
99632
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99633
- * @beta
99634
- */
99635
- singleWavy = "SingleWavy",
99636
- /**
99637
- * Represents the internal single thick solid line surrounded by a single thin solid line with a large gap between them.
99638
- * @remarks
99639
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99640
- * @beta
99641
- */
99642
- thickThinLargeGap = "ThickThinLargeGap",
99643
- /**
99644
- * Represents the internal single thick solid line surrounded by a single thin solid line with a medium gap between them.
99645
- * @remarks
99646
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99647
- * @beta
99648
- */
99649
- thickThinMedGap = "ThickThinMedGap",
99650
- /**
99651
- * Represents the internal single thick solid line surrounded by a single thin solid line with a small gap between them.
99652
- * @remarks
99653
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99654
- * @beta
99655
- */
99656
- thickThinSmallGap = "ThickThinSmallGap",
99657
- /**
99658
- * Represents the internal single thin solid line surrounded by a single thick solid line with a large gap between them.
99659
- * @remarks
99660
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99661
- * @beta
99662
- */
99663
- thinThickLargeGap = "ThinThickLargeGap",
99664
- /**
99665
- * Represents the internal single thin solid line surrounded by a single thick solid line with a medium gap between them.
99666
- * @remarks
99667
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99668
- * @beta
99669
- */
99670
- thinThickMedGap = "ThinThickMedGap",
99671
- /**
99672
- * Represents the internal single thin solid line surrounded by a single thick solid line with a small gap between them.
99673
- * @remarks
99674
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99675
- * @beta
99676
- */
99677
- thinThickSmallGap = "ThinThickSmallGap",
99678
- /**
99679
- * Represents the internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a large gap between all lines.
99680
- * @remarks
99681
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99682
- * @beta
99683
- */
99684
- thinThickThinLargeGap = "ThinThickThinLargeGap",
99685
- /**
99686
- * Represents the internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a medium gap between all lines.
99687
- * @remarks
99688
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99689
- * @beta
99690
- */
99691
- thinThickThinMedGap = "ThinThickThinMedGap",
99692
- /**
99693
- * Represents the internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a small gap between all lines.
99694
- * @remarks
99695
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99696
- * @beta
99697
- */
99698
- thinThickThinSmallGap = "ThinThickThinSmallGap",
99699
- /**
99700
- * Represents the triple line style.
99701
- * @remarks
99702
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99703
- * @beta
99704
- */
99705
- triple = "Triple",
99706
- }
99707
- /**
99708
- * Represents the width of a style's border.
99709
- *
99710
- * @remarks
99711
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99712
- * @beta
99713
- */
99714
- enum LineWidth {
99715
- /**
99716
- * None width.
99717
- * @remarks
99718
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99719
- * @beta
99720
- */
99721
- none = "None",
99722
- /**
99723
- * 0.25 point.
99724
- * @remarks
99725
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99726
- * @beta
99727
- */
99728
- pt025 = "Pt025",
99729
- /**
99730
- * 0.50 point.
99731
- * @remarks
99732
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99733
- * @beta
99734
- */
99735
- pt050 = "Pt050",
99736
- /**
99737
- * 0.75 point.
99738
- * @remarks
99739
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99740
- * @beta
99741
- */
99742
- pt075 = "Pt075",
99743
- /**
99744
- * 1.00 point. This is the default.
99745
- * @remarks
99746
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99747
- * @beta
99748
- */
99749
- pt100 = "Pt100",
99750
- /**
99751
- * 1.50 points.
99752
- * @remarks
99753
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99754
- * @beta
99755
- */
99756
- pt150 = "Pt150",
99757
- /**
99758
- * 2.25 points.
99759
- * @remarks
99760
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99761
- * @beta
99762
- */
99763
- pt225 = "Pt225",
99764
- /**
99765
- * 3.00 points.
99766
- * @remarks
99767
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99768
- * @beta
99769
- */
99770
- pt300 = "Pt300",
99771
- /**
99772
- * 4.50 points.
99773
- * @remarks
99774
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99775
- * @beta
99776
- */
99777
- pt450 = "Pt450",
99599
+ pt450 = "Pt450",
99778
99600
  /**
99779
99601
  * 6.00 points.
99780
99602
  * @remarks
@@ -99790,71 +99612,6 @@ declare namespace Word {
99790
99612
  */
99791
99613
  mixed = "Mixed",
99792
99614
  }
99793
- /**
99794
- * Represents the position of a style's border.
99795
- *
99796
- * @remarks
99797
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99798
- * @beta
99799
- */
99800
- enum BorderPositionType {
99801
- /**
99802
- * Represents the top border.
99803
- * @remarks
99804
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99805
- * @beta
99806
- */
99807
- top = "Top",
99808
- /**
99809
- * Represents the left border.
99810
- * @remarks
99811
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99812
- * @beta
99813
- */
99814
- left = "Left",
99815
- /**
99816
- * Represents the bottom border.
99817
- * @remarks
99818
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99819
- * @beta
99820
- */
99821
- bottom = "Bottom",
99822
- /**
99823
- * Represents the right border.
99824
- * @remarks
99825
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99826
- * @beta
99827
- */
99828
- right = "Right",
99829
- /**
99830
- * Represents the horizontal borders.
99831
- * @remarks
99832
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99833
- * @beta
99834
- */
99835
- horizontal = "Horizontal",
99836
- /**
99837
- * Represents the vertical borders.
99838
- * @remarks
99839
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99840
- * @beta
99841
- */
99842
- vertical = "Vertical",
99843
- /**
99844
- * Represents the diagonal borders starting in the upper-left corner.
99845
- * @remarks
99846
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99847
- * @beta
99848
- */
99849
- diagonalDown = "DiagonalDown",
99850
- /**
99851
- * Represents the diagonal borders starting in the lower-left corner.
99852
- * @remarks
99853
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99854
- * @beta
99855
- */
99856
- diagonalUp = "DiagonalUp",
99857
- }
99858
99615
  /**
99859
99616
  * @remarks
99860
99617
  * [Api set: WordApi 1.3]
@@ -100108,10 +99865,10 @@ declare namespace Word {
100108
99865
  /**
100109
99866
  * Represents the built-in style in a Word document.
100110
99867
  *
100111
- * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5.
100112
- *
100113
99868
  * @remarks
100114
99869
  * [Api set: WordApi 1.3]
99870
+ *
99871
+ * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5.
100115
99872
  */
100116
99873
  enum BuiltInStyleName {
100117
99874
  /**
@@ -101001,7 +100758,7 @@ declare namespace Word {
101001
100758
  */
101002
100759
  enum CloseBehavior {
101003
100760
  /**
101004
- * Save the changes before closing the document.
100761
+ * Saves the changes before closing the document.
101005
100762
  * @remarks
101006
100763
  * [Api set: WordApi 1.5]
101007
100764
  */
@@ -102344,90 +102101,101 @@ declare namespace Word {
102344
102101
  /** An interface for updating data on the Border object, for use in `border.set({ ... })`. */
102345
102102
  interface BorderUpdateData {
102346
102103
  /**
102347
- * Specifies the line color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
102104
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
102348
102105
  *
102349
102106
  * @remarks
102350
102107
  * [Api set: WordApi BETA (PREVIEW ONLY)]
102351
102108
  * @beta
102352
102109
  */
102353
- lineColor?: string;
102110
+ color?: string;
102354
102111
  /**
102355
- * Specifies the line style for the border.
102112
+ * Specifies the border type for the border.
102356
102113
  *
102357
102114
  * @remarks
102358
102115
  * [Api set: WordApi BETA (PREVIEW ONLY)]
102359
102116
  * @beta
102360
102117
  */
102361
- lineStyle?: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
102118
+ type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
102362
102119
  /**
102363
- * Specifies the line width for the border.
102120
+ * Specifies whether the border is visible.
102364
102121
  *
102365
102122
  * @remarks
102366
102123
  * [Api set: WordApi BETA (PREVIEW ONLY)]
102367
102124
  * @beta
102368
102125
  */
102369
- lineWidth?: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
102126
+ visible?: boolean;
102370
102127
  /**
102371
- * Specifies whether the border is visible.
102128
+ * Specifies the width for the border.
102372
102129
  *
102373
102130
  * @remarks
102374
102131
  * [Api set: WordApi BETA (PREVIEW ONLY)]
102375
102132
  * @beta
102376
102133
  */
102377
- visible?: boolean;
102134
+ width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
102378
102135
  }
102379
102136
  /** An interface for updating data on the BorderCollection object, for use in `borderCollection.set({ ... })`. */
102380
102137
  interface BorderCollectionUpdateData {
102381
102138
  /**
102382
- * Specifies the 24-bit color of the inside borders.
102139
+ * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
102383
102140
  *
102384
102141
  * @remarks
102385
102142
  * [Api set: WordApi BETA (PREVIEW ONLY)]
102386
102143
  * @beta
102387
102144
  */
102388
- insideLineColor?: string;
102145
+ insideBorderColor?: string;
102389
102146
  /**
102390
- * Specifies the line style of the inside borders.
102147
+ * Specifies the border type of the inside borders.
102391
102148
  *
102392
102149
  * @remarks
102393
102150
  * [Api set: WordApi BETA (PREVIEW ONLY)]
102394
102151
  * @beta
102395
102152
  */
102396
- insideLineStyle?: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
102153
+ insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
102397
102154
  /**
102398
- * Specifies the line width of the inside borders.
102155
+ * Specifies the width of the inside borders.
102399
102156
  *
102400
102157
  * @remarks
102401
102158
  * [Api set: WordApi BETA (PREVIEW ONLY)]
102402
102159
  * @beta
102403
102160
  */
102404
- insideLineWidth?: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
102161
+ insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
102405
102162
  /**
102406
- * Specifies the 24-bit color of the outside borders.
102163
+ * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name.
102407
102164
  *
102408
102165
  * @remarks
102409
102166
  * [Api set: WordApi BETA (PREVIEW ONLY)]
102410
102167
  * @beta
102411
102168
  */
102412
- outsideLineColor?: string;
102169
+ outsideBorderColor?: string;
102413
102170
  /**
102414
- * Specifies the line style of the outside borders.
102171
+ * Specifies the border type of the outside borders.
102415
102172
  *
102416
102173
  * @remarks
102417
102174
  * [Api set: WordApi BETA (PREVIEW ONLY)]
102418
102175
  * @beta
102419
102176
  */
102420
- outsideLineStyle?: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
102177
+ outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
102421
102178
  /**
102422
- * Specifies the line width of the outside borders.
102179
+ * Specifies the width of the outside borders.
102423
102180
  *
102424
102181
  * @remarks
102425
102182
  * [Api set: WordApi BETA (PREVIEW ONLY)]
102426
102183
  * @beta
102427
102184
  */
102428
- outsideLineWidth?: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
102185
+ outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
102429
102186
  items?: Word.Interfaces.BorderData[];
102430
102187
  }
102188
+ /** An interface for updating data on the CheckboxContentControl object, for use in `checkboxContentControl.set({ ... })`. */
102189
+ interface CheckboxContentControlUpdateData {
102190
+ /**
102191
+ * Specifies the current state of the checkbox.
102192
+ *
102193
+ * @remarks
102194
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
102195
+ * @beta
102196
+ */
102197
+ isChecked?: boolean;
102198
+ }
102431
102199
  /** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */
102432
102200
  interface CommentUpdateData {
102433
102201
  /**
@@ -102487,7 +102255,7 @@ declare namespace Word {
102487
102255
  */
102488
102256
  strikeThrough?: boolean;
102489
102257
  /**
102490
- * Specifies a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
102258
+ * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
102491
102259
  *
102492
102260
  * @remarks
102493
102261
  * [Api set: WordApi 1.4]
@@ -102525,11 +102293,19 @@ declare namespace Word {
102525
102293
  /** An interface for updating data on the ContentControl object, for use in `contentControl.set({ ... })`. */
102526
102294
  interface ContentControlUpdateData {
102527
102295
  /**
102528
- * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
102529
- *
102530
- * @remarks
102531
- * [Api set: WordApi 1.1]
102532
- */
102296
+ * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
102297
+ *
102298
+ * @remarks
102299
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
102300
+ * @beta
102301
+ */
102302
+ checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData;
102303
+ /**
102304
+ * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
102305
+ *
102306
+ * @remarks
102307
+ * [Api set: WordApi 1.1]
102308
+ */
102533
102309
  font?: Word.Interfaces.FontUpdateData;
102534
102310
  /**
102535
102311
  * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
@@ -102560,7 +102336,9 @@ declare namespace Word {
102560
102336
  */
102561
102337
  color?: string;
102562
102338
  /**
102563
- * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. **Note**: The set operation for this property is not supported in Word on the web.
102339
+ * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
102340
+
102341
+ Note: The set operation for this property isn't supported in Word on the web.
102564
102342
  *
102565
102343
  * @remarks
102566
102344
  * [Api set: WordApi 1.1]
@@ -102749,6 +102527,8 @@ declare namespace Word {
102749
102527
  *
102750
102528
  * @remarks
102751
102529
  * [Api set: WordApi 1.4]
102530
+ *
102531
+ * Note: The ability to set the code was introduced in WordApi 1.5.
102752
102532
  */
102753
102533
  code?: string;
102754
102534
  /**
@@ -102859,7 +102639,7 @@ declare namespace Word {
102859
102639
  */
102860
102640
  superscript?: boolean;
102861
102641
  /**
102862
- * Specifies a value that indicates the font's underline type. 'None' if the font is not underlined.
102642
+ * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
102863
102643
  *
102864
102644
  * @remarks
102865
102645
  * [Api set: WordApi 1.1]
@@ -103066,7 +102846,7 @@ declare namespace Word {
103066
102846
  */
103067
102847
  font?: Word.Interfaces.FontUpdateData;
103068
102848
  /**
103069
- * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph is not part of a list.
102849
+ * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
103070
102850
  *
103071
102851
  * @remarks
103072
102852
  * [Api set: WordApi 1.3]
@@ -103359,7 +103139,7 @@ declare namespace Word {
103359
103139
  /** An interface for updating data on the Section object, for use in `section.set({ ... })`. */
103360
103140
  interface SectionUpdateData {
103361
103141
  /**
103362
- * Gets the body object of the section. This does not include the header/footer and other section metadata.
103142
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
103363
103143
  *
103364
103144
  * @remarks
103365
103145
  * [Api set: WordApi 1.1]
@@ -103424,25 +103204,41 @@ declare namespace Word {
103424
103204
  * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
103425
103205
  *
103426
103206
  * @remarks
103427
- * [Api set: WordApi BETA (PREVIEW ONLY)]
103428
- * @beta
103207
+ * [Api set: WordApi 1.6]
103429
103208
  */
103430
103209
  shading?: Word.Interfaces.ShadingUpdateData;
103431
103210
  /**
103432
103211
  * Gets a TableStyle object representing Style properties that can be applied to a table.
103433
103212
  *
103434
103213
  * @remarks
103435
- * [Api set: WordApi BETA (PREVIEW ONLY)]
103436
- * @beta
103214
+ * [Api set: WordApi 1.6]
103437
103215
  */
103438
103216
  tableStyle?: Word.Interfaces.TableStyleUpdateData;
103439
103217
  /**
103440
- * Specifies the priority.
103218
+ * Specifies the name of an existing style to use as the base formatting of another style.
103441
103219
  *
103442
103220
  * @remarks
103443
103221
  * [Api set: WordApi 1.5]
103222
+ *
103223
+ * Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
103444
103224
  */
103445
- priority?: number;
103225
+ baseStyle?: string;
103226
+ /**
103227
+ * 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.
103228
+ *
103229
+ * @remarks
103230
+ * [Api set: WordApi 1.5]
103231
+ *
103232
+ * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
103233
+ */
103234
+ nextParagraphStyle?: string;
103235
+ /**
103236
+ * Specifies the priority.
103237
+ *
103238
+ * @remarks
103239
+ * [Api set: WordApi 1.5]
103240
+ */
103241
+ priority?: number;
103446
103242
  /**
103447
103243
  * Specifies whether the style corresponds to an available quick style.
103448
103244
  *
@@ -103471,8 +103267,7 @@ declare namespace Word {
103471
103267
  * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
103472
103268
  *
103473
103269
  * @remarks
103474
- * [Api set: WordApi BETA (PREVIEW ONLY)]
103475
- * @beta
103270
+ * [Api set: WordApi 1.6]
103476
103271
  */
103477
103272
  backgroundPatternColor?: string;
103478
103273
  /**
@@ -103622,40 +103417,35 @@ declare namespace Word {
103622
103417
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
103623
103418
  *
103624
103419
  * @remarks
103625
- * [Api set: WordApi BETA (PREVIEW ONLY)]
103626
- * @beta
103420
+ * [Api set: WordApi 1.6]
103627
103421
  */
103628
103422
  bottomCellMargin?: number;
103629
103423
  /**
103630
103424
  * Specifies the spacing (in points) between the cells in a table style.
103631
103425
  *
103632
103426
  * @remarks
103633
- * [Api set: WordApi BETA (PREVIEW ONLY)]
103634
- * @beta
103427
+ * [Api set: WordApi 1.6]
103635
103428
  */
103636
103429
  cellSpacing?: number;
103637
103430
  /**
103638
103431
  * Specifies the amount of space to add between the contents and the left borders of the cells.
103639
103432
  *
103640
103433
  * @remarks
103641
- * [Api set: WordApi BETA (PREVIEW ONLY)]
103642
- * @beta
103434
+ * [Api set: WordApi 1.6]
103643
103435
  */
103644
103436
  leftCellMargin?: number;
103645
103437
  /**
103646
103438
  * Specifies the amount of space to add between the contents and the right borders of the cells.
103647
103439
  *
103648
103440
  * @remarks
103649
- * [Api set: WordApi BETA (PREVIEW ONLY)]
103650
- * @beta
103441
+ * [Api set: WordApi 1.6]
103651
103442
  */
103652
103443
  rightCellMargin?: number;
103653
103444
  /**
103654
103445
  * Specifies the amount of space to add between the contents and the top borders of the cells.
103655
103446
  *
103656
103447
  * @remarks
103657
- * [Api set: WordApi BETA (PREVIEW ONLY)]
103658
- * @beta
103448
+ * [Api set: WordApi 1.6]
103659
103449
  */
103660
103450
  topCellMargin?: number;
103661
103451
  }
@@ -103826,53 +103616,55 @@ declare namespace Word {
103826
103616
  /** An interface describing the data returned by calling `body.toJSON()`. */
103827
103617
  interface BodyData {
103828
103618
  /**
103829
- * Gets the collection of rich text content control objects in the body.
103830
- *
103831
- * @remarks
103832
- * [Api set: WordApi 1.1]
103833
- */
103619
+ * Gets the collection of rich text content control objects in the body.
103620
+ *
103621
+ * @remarks
103622
+ * [Api set: WordApi 1.1]
103623
+ */
103834
103624
  contentControls?: Word.Interfaces.ContentControlData[];
103835
103625
  /**
103836
- * Gets the collection of field objects in the body.
103837
- *
103838
- * @remarks
103839
- * [Api set: WordApi 1.4]
103840
- */
103626
+ * Gets the collection of field objects in the body.
103627
+ *
103628
+ * @remarks
103629
+ * [Api set: WordApi 1.4]
103630
+ */
103841
103631
  fields?: Word.Interfaces.FieldData[];
103842
103632
  /**
103843
- * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
103844
- *
103845
- * @remarks
103846
- * [Api set: WordApi 1.1]
103847
- */
103633
+ * Gets the text format of the body. Use this to get and set font name, size, color and other properties.
103634
+ *
103635
+ * @remarks
103636
+ * [Api set: WordApi 1.1]
103637
+ */
103848
103638
  font?: Word.Interfaces.FontData;
103849
103639
  /**
103850
- * Gets the collection of InlinePicture objects in the body. The collection does not include floating images.
103851
- *
103852
- * @remarks
103853
- * [Api set: WordApi 1.1]
103854
- */
103640
+ * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images.
103641
+ *
103642
+ * @remarks
103643
+ * [Api set: WordApi 1.1]
103644
+ */
103855
103645
  inlinePictures?: Word.Interfaces.InlinePictureData[];
103856
103646
  /**
103857
- * Gets the collection of list objects in the body.
103858
- *
103859
- * @remarks
103860
- * [Api set: WordApi 1.3]
103861
- */
103647
+ * Gets the collection of list objects in the body.
103648
+ *
103649
+ * @remarks
103650
+ * [Api set: WordApi 1.3]
103651
+ */
103862
103652
  lists?: Word.Interfaces.ListData[];
103863
103653
  /**
103864
- * Gets the collection of paragraph objects in the body. **Important**: Paragraphs in tables are not returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned.
103865
- *
103866
- * @remarks
103867
- * [Api set: WordApi 1.1]
103868
- */
103654
+ * Gets the collection of paragraph objects in the body.
103655
+ *
103656
+ * @remarks
103657
+ * [Api set: WordApi 1.1]
103658
+ *
103659
+ * 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.
103660
+ */
103869
103661
  paragraphs?: Word.Interfaces.ParagraphData[];
103870
103662
  /**
103871
- * Gets the collection of table objects in the body.
103872
- *
103873
- * @remarks
103874
- * [Api set: WordApi 1.3]
103875
- */
103663
+ * Gets the collection of table objects in the body.
103664
+ *
103665
+ * @remarks
103666
+ * [Api set: WordApi 1.3]
103667
+ */
103876
103668
  tables?: Word.Interfaces.TableData[];
103877
103669
  /**
103878
103670
  * 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.
@@ -103906,50 +103698,61 @@ declare namespace Word {
103906
103698
  /** An interface describing the data returned by calling `border.toJSON()`. */
103907
103699
  interface BorderData {
103908
103700
  /**
103909
- * Specifies the line color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
103701
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
103910
103702
  *
103911
103703
  * @remarks
103912
103704
  * [Api set: WordApi BETA (PREVIEW ONLY)]
103913
103705
  * @beta
103914
103706
  */
103915
- lineColor?: string;
103707
+ color?: string;
103916
103708
  /**
103917
- * Specifies the line style for the border.
103709
+ * Gets the location of the border.
103918
103710
  *
103919
103711
  * @remarks
103920
103712
  * [Api set: WordApi BETA (PREVIEW ONLY)]
103921
103713
  * @beta
103922
103714
  */
103923
- lineStyle?: Word.LineStyle | "DashDot" | "DashDotDot" | "DashDotStroked" | "DashLargeGap" | "DashSmallGap" | "Dot" | "Double" | "DoubleWavy" | "Emboss3D" | "Engrave3D" | "Inset" | "Mixed" | "None" | "Outset" | "Single" | "SingleWavy" | "ThickThinLargeGap" | "ThickThinMedGap" | "ThickThinSmallGap" | "ThinThickLargeGap" | "ThinThickMedGap" | "ThinThickSmallGap" | "ThinThickThinLargeGap" | "ThinThickThinMedGap" | "ThinThickThinSmallGap" | "Triple";
103715
+ location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";
103924
103716
  /**
103925
- * Specifies the line width for the border.
103717
+ * Specifies the border type for the border.
103926
103718
  *
103927
103719
  * @remarks
103928
103720
  * [Api set: WordApi BETA (PREVIEW ONLY)]
103929
103721
  * @beta
103930
103722
  */
103931
- lineWidth?: Word.LineWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
103723
+ type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";
103932
103724
  /**
103933
- * Gets the position type of the border.
103725
+ * Specifies whether the border is visible.
103934
103726
  *
103935
103727
  * @remarks
103936
103728
  * [Api set: WordApi BETA (PREVIEW ONLY)]
103937
103729
  * @beta
103938
103730
  */
103939
- positionType?: Word.BorderPositionType | "Top" | "Left" | "Bottom" | "Right" | "Horizontal" | "Vertical" | "DiagonalDown" | "DiagonalUp";
103731
+ visible?: boolean;
103940
103732
  /**
103941
- * Specifies whether the border is visible.
103733
+ * Specifies the width for the border.
103942
103734
  *
103943
103735
  * @remarks
103944
103736
  * [Api set: WordApi BETA (PREVIEW ONLY)]
103945
103737
  * @beta
103946
103738
  */
103947
- visible?: boolean;
103739
+ width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";
103948
103740
  }
103949
103741
  /** An interface describing the data returned by calling `borderCollection.toJSON()`. */
103950
103742
  interface BorderCollectionData {
103951
103743
  items?: Word.Interfaces.BorderData[];
103952
103744
  }
103745
+ /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */
103746
+ interface CheckboxContentControlData {
103747
+ /**
103748
+ * Specifies the current state of the checkbox.
103749
+ *
103750
+ * @remarks
103751
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
103752
+ * @beta
103753
+ */
103754
+ isChecked?: boolean;
103755
+ }
103953
103756
  /** An interface describing the data returned by calling `comment.toJSON()`. */
103954
103757
  interface CommentData {
103955
103758
  /**
@@ -104058,7 +103861,7 @@ declare namespace Word {
104058
103861
  */
104059
103862
  text?: string;
104060
103863
  /**
104061
- * Specifies a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
103864
+ * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
104062
103865
  *
104063
103866
  * @remarks
104064
103867
  * [Api set: WordApi 1.4]
@@ -104124,53 +103927,63 @@ declare namespace Word {
104124
103927
  /** An interface describing the data returned by calling `contentControl.toJSON()`. */
104125
103928
  interface ContentControlData {
104126
103929
  /**
104127
- * Gets the collection of content control objects in the content control.
104128
- *
104129
- * @remarks
104130
- * [Api set: WordApi 1.1]
104131
- */
103930
+ * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
103931
+ *
103932
+ * @remarks
103933
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
103934
+ * @beta
103935
+ */
103936
+ checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;
103937
+ /**
103938
+ * Gets the collection of content control objects in the content control.
103939
+ *
103940
+ * @remarks
103941
+ * [Api set: WordApi 1.1]
103942
+ */
104132
103943
  contentControls?: Word.Interfaces.ContentControlData[];
104133
103944
  /**
104134
- * Gets the collection of field objects in the content control.
104135
- *
104136
- * @remarks
104137
- * [Api set: WordApi 1.4]
104138
- */
103945
+ * Gets the collection of field objects in the content control.
103946
+ *
103947
+ * @remarks
103948
+ * [Api set: WordApi 1.4]
103949
+ */
104139
103950
  fields?: Word.Interfaces.FieldData[];
104140
103951
  /**
104141
- * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
104142
- *
104143
- * @remarks
104144
- * [Api set: WordApi 1.1]
104145
- */
103952
+ * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
103953
+ *
103954
+ * @remarks
103955
+ * [Api set: WordApi 1.1]
103956
+ */
104146
103957
  font?: Word.Interfaces.FontData;
104147
103958
  /**
104148
- * Gets the collection of InlinePicture objects in the content control. The collection does not include floating images.
104149
- *
104150
- * @remarks
104151
- * [Api set: WordApi 1.1]
104152
- */
103959
+ * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images.
103960
+ *
103961
+ * @remarks
103962
+ * [Api set: WordApi 1.1]
103963
+ */
104153
103964
  inlinePictures?: Word.Interfaces.InlinePictureData[];
104154
103965
  /**
104155
- * Gets the collection of list objects in the content control.
104156
- *
104157
- * @remarks
104158
- * [Api set: WordApi 1.3]
104159
- */
103966
+ * Gets the collection of list objects in the content control.
103967
+ *
103968
+ * @remarks
103969
+ * [Api set: WordApi 1.3]
103970
+ */
104160
103971
  lists?: Word.Interfaces.ListData[];
104161
103972
  /**
104162
- * Gets the collection of paragraph objects in the content control. **Important**: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control are not returned. From requirement set 1.3, paragraphs in such tables are also returned.
104163
- *
104164
- * @remarks
104165
- * [Api set: WordApi 1.1]
104166
- */
103973
+ * Gets the collection of paragraph objects in the content control.
103974
+ *
103975
+ * @remarks
103976
+ * [Api set: WordApi 1.1]
103977
+ *
103978
+ * 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.
103979
+ */
104167
103980
  paragraphs?: Word.Interfaces.ParagraphData[];
104168
103981
  /**
104169
- * Gets the collection of table objects in the content control.
104170
- *
104171
- * @remarks
104172
- * [Api set: WordApi 1.3]
104173
- */
103982
+ * Gets the collection of table objects in the content control.
103983
+ *
103984
+ * @remarks
103985
+ * [Api set: WordApi 1.3]
103986
+ */
104174
103987
  tables?: Word.Interfaces.TableData[];
104175
103988
  /**
104176
103989
  * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
@@ -104193,14 +104006,6 @@ declare namespace Word {
104193
104006
  * [Api set: WordApi 1.1]
104194
104007
  */
104195
104008
  cannotEdit?: boolean;
104196
- /**
104197
- * Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
104198
- *
104199
- * @remarks
104200
- * [Api set: WordApi BETA (PREVIEW ONLY)]
104201
- * @beta
104202
- */
104203
- checkboxContentControl?: Word.CheckboxContentControl;
104204
104009
  /**
104205
104010
  * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
104206
104011
  *
@@ -104216,7 +104021,9 @@ declare namespace Word {
104216
104021
  */
104217
104022
  id?: number;
104218
104023
  /**
104219
- * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. **Note**: The set operation for this property is not supported in Word on the web.
104024
+ * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
104025
+
104026
+ Note: The set operation for this property isn't supported in Word on the web.
104220
104027
  *
104221
104028
  * @remarks
104222
104029
  * [Api set: WordApi 1.1]
@@ -104716,7 +104523,7 @@ declare namespace Word {
104716
104523
  */
104717
104524
  superscript?: boolean;
104718
104525
  /**
104719
- * Specifies a value that indicates the font's underline type. 'None' if the font is not underlined.
104526
+ * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
104720
104527
  *
104721
104528
  * @remarks
104722
104529
  * [Api set: WordApi 1.1]
@@ -104998,14 +104805,14 @@ declare namespace Word {
104998
104805
  */
104999
104806
  font?: Word.Interfaces.FontData;
105000
104807
  /**
105001
- * Gets the collection of InlinePicture objects in the paragraph. The collection does not include floating images.
104808
+ * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images.
105002
104809
  *
105003
104810
  * @remarks
105004
104811
  * [Api set: WordApi 1.1]
105005
104812
  */
105006
104813
  inlinePictures?: Word.Interfaces.InlinePictureData[];
105007
104814
  /**
105008
- * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph is not part of a list.
104815
+ * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
105009
104816
  *
105010
104817
  * @remarks
105011
104818
  * [Api set: WordApi 1.3]
@@ -105117,7 +104924,7 @@ declare namespace Word {
105117
104924
  */
105118
104925
  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";
105119
104926
  /**
105120
- * Gets the level of the paragraph's table. It returns 0 if the paragraph is not in a table.
104927
+ * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
105121
104928
  *
105122
104929
  * @remarks
105123
104930
  * [Api set: WordApi 1.3]
@@ -105134,8 +104941,7 @@ declare namespace Word {
105134
104941
  * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
105135
104942
  *
105136
104943
  * @remarks
105137
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105138
- * @beta
104944
+ * [Api set: WordApi 1.6]
105139
104945
  */
105140
104946
  uniqueLocalId?: string;
105141
104947
  }
@@ -105362,7 +105168,7 @@ declare namespace Word {
105362
105168
  /** An interface describing the data returned by calling `section.toJSON()`. */
105363
105169
  interface SectionData {
105364
105170
  /**
105365
- * Gets the body object of the section. This does not include the header/footer and other section metadata.
105171
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
105366
105172
  *
105367
105173
  * @remarks
105368
105174
  * [Api set: WordApi 1.1]
@@ -105434,23 +105240,23 @@ declare namespace Word {
105434
105240
  * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
105435
105241
  *
105436
105242
  * @remarks
105437
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105438
- * @beta
105243
+ * [Api set: WordApi 1.6]
105439
105244
  */
105440
105245
  shading?: Word.Interfaces.ShadingData;
105441
105246
  /**
105442
105247
  * Gets a TableStyle object representing Style properties that can be applied to a table.
105443
105248
  *
105444
105249
  * @remarks
105445
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105446
- * @beta
105250
+ * [Api set: WordApi 1.6]
105447
105251
  */
105448
105252
  tableStyle?: Word.Interfaces.TableStyleData;
105449
105253
  /**
105450
- * Gets the name of an existing style to use as the base formatting of another style.
105254
+ * Specifies the name of an existing style to use as the base formatting of another style.
105451
105255
  *
105452
105256
  * @remarks
105453
105257
  * [Api set: WordApi 1.5]
105258
+ *
105259
+ * Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
105454
105260
  */
105455
105261
  baseStyle?: string;
105456
105262
  /**
@@ -105490,10 +105296,12 @@ declare namespace Word {
105490
105296
  */
105491
105297
  nameLocal?: string;
105492
105298
  /**
105493
- * Gets the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.
105299
+ * 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.
105494
105300
  *
105495
105301
  * @remarks
105496
105302
  * [Api set: WordApi 1.5]
105303
+ *
105304
+ * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
105497
105305
  */
105498
105306
  nextParagraphStyle?: string;
105499
105307
  /**
@@ -105538,8 +105346,7 @@ declare namespace Word {
105538
105346
  * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
105539
105347
  *
105540
105348
  * @remarks
105541
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105542
- * @beta
105349
+ * [Api set: WordApi 1.6]
105543
105350
  */
105544
105351
  backgroundPatternColor?: string;
105545
105352
  /**
@@ -105731,40 +105538,35 @@ declare namespace Word {
105731
105538
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
105732
105539
  *
105733
105540
  * @remarks
105734
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105735
- * @beta
105541
+ * [Api set: WordApi 1.6]
105736
105542
  */
105737
105543
  bottomCellMargin?: number;
105738
105544
  /**
105739
105545
  * Specifies the spacing (in points) between the cells in a table style.
105740
105546
  *
105741
105547
  * @remarks
105742
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105743
- * @beta
105548
+ * [Api set: WordApi 1.6]
105744
105549
  */
105745
105550
  cellSpacing?: number;
105746
105551
  /**
105747
105552
  * Specifies the amount of space to add between the contents and the left borders of the cells.
105748
105553
  *
105749
105554
  * @remarks
105750
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105751
- * @beta
105555
+ * [Api set: WordApi 1.6]
105752
105556
  */
105753
105557
  leftCellMargin?: number;
105754
105558
  /**
105755
105559
  * Specifies the amount of space to add between the contents and the right borders of the cells.
105756
105560
  *
105757
105561
  * @remarks
105758
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105759
- * @beta
105562
+ * [Api set: WordApi 1.6]
105760
105563
  */
105761
105564
  rightCellMargin?: number;
105762
105565
  /**
105763
105566
  * Specifies the amount of space to add between the contents and the top borders of the cells.
105764
105567
  *
105765
105568
  * @remarks
105766
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105767
- * @beta
105569
+ * [Api set: WordApi 1.6]
105768
105570
  */
105769
105571
  topCellMargin?: number;
105770
105572
  }
@@ -105953,35 +105755,31 @@ declare namespace Word {
105953
105755
  /** An interface describing the data returned by calling `trackedChange.toJSON()`. */
105954
105756
  interface TrackedChangeData {
105955
105757
  /**
105956
- * Specifies the author of the tracked change.
105758
+ * Gets the author of the tracked change.
105957
105759
  *
105958
105760
  * @remarks
105959
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105960
- * @beta
105761
+ * [Api set: WordApi 1.6]
105961
105762
  */
105962
105763
  author?: string;
105963
105764
  /**
105964
- * Specifies the date of the tracked change.
105765
+ * Gets the date of the tracked change.
105965
105766
  *
105966
105767
  * @remarks
105967
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105968
- * @beta
105768
+ * [Api set: WordApi 1.6]
105969
105769
  */
105970
105770
  date?: Date;
105971
105771
  /**
105972
- * Specifies the text of the tracked change.
105772
+ * Gets the text of the tracked change.
105973
105773
  *
105974
105774
  * @remarks
105975
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105976
- * @beta
105775
+ * [Api set: WordApi 1.6]
105977
105776
  */
105978
105777
  text?: string;
105979
105778
  /**
105980
- * Specifies the type of the tracked change.
105779
+ * Gets the type of the tracked change.
105981
105780
  *
105982
105781
  * @remarks
105983
- * [Api set: WordApi BETA (PREVIEW ONLY)]
105984
- * @beta
105782
+ * [Api set: WordApi 1.6]
105985
105783
  */
105986
105784
  type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted";
105987
105785
  }
@@ -106194,45 +105992,45 @@ declare namespace Word {
106194
105992
  */
106195
105993
  $all?: boolean;
106196
105994
  /**
106197
- * Specifies the line color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
105995
+ * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
106198
105996
  *
106199
105997
  * @remarks
106200
105998
  * [Api set: WordApi BETA (PREVIEW ONLY)]
106201
105999
  * @beta
106202
106000
  */
106203
- lineColor?: boolean;
106001
+ color?: boolean;
106204
106002
  /**
106205
- * Specifies the line style for the border.
106003
+ * Gets the location of the border.
106206
106004
  *
106207
106005
  * @remarks
106208
106006
  * [Api set: WordApi BETA (PREVIEW ONLY)]
106209
106007
  * @beta
106210
106008
  */
106211
- lineStyle?: boolean;
106009
+ location?: boolean;
106212
106010
  /**
106213
- * Specifies the line width for the border.
106011
+ * Specifies the border type for the border.
106214
106012
  *
106215
106013
  * @remarks
106216
106014
  * [Api set: WordApi BETA (PREVIEW ONLY)]
106217
106015
  * @beta
106218
106016
  */
106219
- lineWidth?: boolean;
106017
+ type?: boolean;
106220
106018
  /**
106221
- * Gets the position type of the border.
106019
+ * Specifies whether the border is visible.
106222
106020
  *
106223
106021
  * @remarks
106224
106022
  * [Api set: WordApi BETA (PREVIEW ONLY)]
106225
106023
  * @beta
106226
106024
  */
106227
- positionType?: boolean;
106025
+ visible?: boolean;
106228
106026
  /**
106229
- * Specifies whether the border is visible.
106027
+ * Specifies the width for the border.
106230
106028
  *
106231
106029
  * @remarks
106232
106030
  * [Api set: WordApi BETA (PREVIEW ONLY)]
106233
106031
  * @beta
106234
106032
  */
106235
- visible?: boolean;
106033
+ width?: boolean;
106236
106034
  }
106237
106035
  /**
106238
106036
  * Represents the collection of border styles.
@@ -106247,45 +106045,66 @@ declare namespace Word {
106247
106045
  */
106248
106046
  $all?: boolean;
106249
106047
  /**
106250
- * For EACH ITEM in the collection: Specifies the line color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
106048
+ * For EACH ITEM in the collection: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
106251
106049
  *
106252
106050
  * @remarks
106253
106051
  * [Api set: WordApi BETA (PREVIEW ONLY)]
106254
106052
  * @beta
106255
106053
  */
106256
- lineColor?: boolean;
106054
+ color?: boolean;
106257
106055
  /**
106258
- * For EACH ITEM in the collection: Specifies the line style for the border.
106056
+ * For EACH ITEM in the collection: Gets the location of the border.
106259
106057
  *
106260
106058
  * @remarks
106261
106059
  * [Api set: WordApi BETA (PREVIEW ONLY)]
106262
106060
  * @beta
106263
106061
  */
106264
- lineStyle?: boolean;
106062
+ location?: boolean;
106265
106063
  /**
106266
- * For EACH ITEM in the collection: Specifies the line width for the border.
106064
+ * For EACH ITEM in the collection: Specifies the border type for the border.
106267
106065
  *
106268
106066
  * @remarks
106269
106067
  * [Api set: WordApi BETA (PREVIEW ONLY)]
106270
106068
  * @beta
106271
106069
  */
106272
- lineWidth?: boolean;
106070
+ type?: boolean;
106273
106071
  /**
106274
- * For EACH ITEM in the collection: Gets the position type of the border.
106072
+ * For EACH ITEM in the collection: Specifies whether the border is visible.
106275
106073
  *
106276
106074
  * @remarks
106277
106075
  * [Api set: WordApi BETA (PREVIEW ONLY)]
106278
106076
  * @beta
106279
106077
  */
106280
- positionType?: boolean;
106078
+ visible?: boolean;
106281
106079
  /**
106282
- * For EACH ITEM in the collection: Specifies whether the border is visible.
106080
+ * For EACH ITEM in the collection: Specifies the width for the border.
106283
106081
  *
106284
106082
  * @remarks
106285
106083
  * [Api set: WordApi BETA (PREVIEW ONLY)]
106286
106084
  * @beta
106287
106085
  */
106288
- visible?: boolean;
106086
+ width?: boolean;
106087
+ }
106088
+ /**
106089
+ * The data specific to content controls of type CheckBox.
106090
+ *
106091
+ * @remarks
106092
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
106093
+ * @beta
106094
+ */
106095
+ interface CheckboxContentControlLoadOptions {
106096
+ /**
106097
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
106098
+ */
106099
+ $all?: boolean;
106100
+ /**
106101
+ * Specifies the current state of the checkbox.
106102
+ *
106103
+ * @remarks
106104
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
106105
+ * @beta
106106
+ */
106107
+ isChecked?: boolean;
106289
106108
  }
106290
106109
  /**
106291
106110
  * Represents a comment in the document.
@@ -106461,7 +106280,7 @@ declare namespace Word {
106461
106280
  */
106462
106281
  text?: boolean;
106463
106282
  /**
106464
- * Specifies a value that indicates the comment text's underline type. 'None' if the comment text is not underlined.
106283
+ * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined.
106465
106284
  *
106466
106285
  * @remarks
106467
106286
  * [Api set: WordApi 1.4]
@@ -106602,60 +106421,68 @@ declare namespace Word {
106602
106421
  */
106603
106422
  $all?: boolean;
106604
106423
  /**
106605
- * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
106606
- *
106607
- * @remarks
106608
- * [Api set: WordApi 1.1]
106609
- */
106424
+ * Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
106425
+ *
106426
+ * @remarks
106427
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
106428
+ * @beta
106429
+ */
106430
+ checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
106431
+ /**
106432
+ * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties.
106433
+ *
106434
+ * @remarks
106435
+ * [Api set: WordApi 1.1]
106436
+ */
106610
106437
  font?: Word.Interfaces.FontLoadOptions;
106611
106438
  /**
106612
- * Gets the parent body of the content control.
106613
- *
106614
- * @remarks
106615
- * [Api set: WordApi 1.3]
106616
- */
106439
+ * Gets the parent body of the content control.
106440
+ *
106441
+ * @remarks
106442
+ * [Api set: WordApi 1.3]
106443
+ */
106617
106444
  parentBody?: Word.Interfaces.BodyLoadOptions;
106618
106445
  /**
106619
- * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control.
106620
- *
106621
- * @remarks
106622
- * [Api set: WordApi 1.1]
106623
- */
106446
+ * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control.
106447
+ *
106448
+ * @remarks
106449
+ * [Api set: WordApi 1.1]
106450
+ */
106624
106451
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
106625
106452
  /**
106626
- * 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}.
106627
- *
106628
- * @remarks
106629
- * [Api set: WordApi 1.3]
106630
- */
106453
+ * 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}.
106454
+ *
106455
+ * @remarks
106456
+ * [Api set: WordApi 1.3]
106457
+ */
106631
106458
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
106632
106459
  /**
106633
- * Gets the table that contains the content control. Throws an `ItemNotFound` error if it is not contained in a table.
106634
- *
106635
- * @remarks
106636
- * [Api set: WordApi 1.3]
106637
- */
106460
+ * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table.
106461
+ *
106462
+ * @remarks
106463
+ * [Api set: WordApi 1.3]
106464
+ */
106638
106465
  parentTable?: Word.Interfaces.TableLoadOptions;
106639
106466
  /**
106640
- * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it is not contained in a table cell.
106641
- *
106642
- * @remarks
106643
- * [Api set: WordApi 1.3]
106644
- */
106467
+ * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell.
106468
+ *
106469
+ * @remarks
106470
+ * [Api set: WordApi 1.3]
106471
+ */
106645
106472
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
106646
106473
  /**
106647
- * 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}.
106648
- *
106649
- * @remarks
106650
- * [Api set: WordApi 1.3]
106651
- */
106474
+ * 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}.
106475
+ *
106476
+ * @remarks
106477
+ * [Api set: WordApi 1.3]
106478
+ */
106652
106479
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
106653
106480
  /**
106654
- * 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}.
106655
- *
106656
- * @remarks
106657
- * [Api set: WordApi 1.3]
106658
- */
106481
+ * 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}.
106482
+ *
106483
+ * @remarks
106484
+ * [Api set: WordApi 1.3]
106485
+ */
106659
106486
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
106660
106487
  /**
106661
106488
  * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
@@ -106678,14 +106505,6 @@ declare namespace Word {
106678
106505
  * [Api set: WordApi 1.1]
106679
106506
  */
106680
106507
  cannotEdit?: boolean;
106681
- /**
106682
- * Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
106683
- *
106684
- * @remarks
106685
- * [Api set: WordApi BETA (PREVIEW ONLY)]
106686
- * @beta
106687
- */
106688
- checkboxContentControl?: boolean;
106689
106508
  /**
106690
106509
  * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
106691
106510
  *
@@ -106701,7 +106520,9 @@ declare namespace Word {
106701
106520
  */
106702
106521
  id?: boolean;
106703
106522
  /**
106704
- * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. **Note**: The set operation for this property is not supported in Word on the web.
106523
+ * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
106524
+
106525
+ Note: The set operation for this property isn't supported in Word on the web.
106705
106526
  *
106706
106527
  * @remarks
106707
106528
  * [Api set: WordApi 1.1]
@@ -106776,60 +106597,68 @@ declare namespace Word {
106776
106597
  */
106777
106598
  $all?: boolean;
106778
106599
  /**
106779
- * 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.
106780
- *
106781
- * @remarks
106782
- * [Api set: WordApi 1.1]
106783
- */
106600
+ * For EACH ITEM in the collection: Specifies the checkbox-related data if the content control's type is 'CheckBox'. It's null otherwise.
106601
+ *
106602
+ * @remarks
106603
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
106604
+ * @beta
106605
+ */
106606
+ checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
106607
+ /**
106608
+ * 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.
106609
+ *
106610
+ * @remarks
106611
+ * [Api set: WordApi 1.1]
106612
+ */
106784
106613
  font?: Word.Interfaces.FontLoadOptions;
106785
106614
  /**
106786
- * For EACH ITEM in the collection: Gets the parent body of the content control.
106787
- *
106788
- * @remarks
106789
- * [Api set: WordApi 1.3]
106790
- */
106615
+ * For EACH ITEM in the collection: Gets the parent body of the content control.
106616
+ *
106617
+ * @remarks
106618
+ * [Api set: WordApi 1.3]
106619
+ */
106791
106620
  parentBody?: Word.Interfaces.BodyLoadOptions;
106792
106621
  /**
106793
- * 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.
106794
- *
106795
- * @remarks
106796
- * [Api set: WordApi 1.1]
106797
- */
106622
+ * 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.
106623
+ *
106624
+ * @remarks
106625
+ * [Api set: WordApi 1.1]
106626
+ */
106798
106627
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
106799
106628
  /**
106800
- * 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}.
106801
- *
106802
- * @remarks
106803
- * [Api set: WordApi 1.3]
106804
- */
106629
+ * 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}.
106630
+ *
106631
+ * @remarks
106632
+ * [Api set: WordApi 1.3]
106633
+ */
106805
106634
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
106806
- /**
106807
- * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it is not contained in a table.
106808
- *
106809
- * @remarks
106810
- * [Api set: WordApi 1.3]
106811
- */
106635
+ /**
106636
+ * 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.
106637
+ *
106638
+ * @remarks
106639
+ * [Api set: WordApi 1.3]
106640
+ */
106812
106641
  parentTable?: Word.Interfaces.TableLoadOptions;
106813
106642
  /**
106814
- * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it is not contained in a table cell.
106815
- *
106816
- * @remarks
106817
- * [Api set: WordApi 1.3]
106818
- */
106643
+ * 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.
106644
+ *
106645
+ * @remarks
106646
+ * [Api set: WordApi 1.3]
106647
+ */
106819
106648
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
106820
106649
  /**
106821
- * 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}.
106822
- *
106823
- * @remarks
106824
- * [Api set: WordApi 1.3]
106825
- */
106650
+ * 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}.
106651
+ *
106652
+ * @remarks
106653
+ * [Api set: WordApi 1.3]
106654
+ */
106826
106655
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
106827
106656
  /**
106828
- * 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}.
106829
- *
106830
- * @remarks
106831
- * [Api set: WordApi 1.3]
106832
- */
106657
+ * 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}.
106658
+ *
106659
+ * @remarks
106660
+ * [Api set: WordApi 1.3]
106661
+ */
106833
106662
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
106834
106663
  /**
106835
106664
  * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'.
@@ -106852,14 +106681,6 @@ declare namespace Word {
106852
106681
  * [Api set: WordApi 1.1]
106853
106682
  */
106854
106683
  cannotEdit?: boolean;
106855
- /**
106856
- * For EACH ITEM in the collection: Gets the checkbox-related data if the content control's type is 'CheckBox'. Returns null otherwise.
106857
- *
106858
- * @remarks
106859
- * [Api set: WordApi BETA (PREVIEW ONLY)]
106860
- * @beta
106861
- */
106862
- checkboxContentControl?: boolean;
106863
106684
  /**
106864
106685
  * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name.
106865
106686
  *
@@ -106875,7 +106696,9 @@ declare namespace Word {
106875
106696
  */
106876
106697
  id?: boolean;
106877
106698
  /**
106878
- * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. **Note**: The set operation for this property is not supported in Word on the web.
106699
+ * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty.
106700
+
106701
+ Note: The set operation for this property isn't supported in Word on the web.
106879
106702
  *
106880
106703
  * @remarks
106881
106704
  * [Api set: WordApi 1.1]
@@ -107319,14 +107142,14 @@ declare namespace Word {
107319
107142
  */
107320
107143
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
107321
107144
  /**
107322
- * Gets the table that contains the field. Throws an `ItemNotFound` error if it is not contained in a table.
107145
+ * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table.
107323
107146
  *
107324
107147
  * @remarks
107325
107148
  * [Api set: WordApi 1.4]
107326
107149
  */
107327
107150
  parentTable?: Word.Interfaces.TableLoadOptions;
107328
107151
  /**
107329
- * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it is not contained in a table cell.
107152
+ * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell.
107330
107153
  *
107331
107154
  * @remarks
107332
107155
  * [Api set: WordApi 1.4]
@@ -107432,14 +107255,14 @@ declare namespace Word {
107432
107255
  */
107433
107256
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
107434
107257
  /**
107435
- * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it is not contained in a table.
107258
+ * 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.
107436
107259
  *
107437
107260
  * @remarks
107438
107261
  * [Api set: WordApi 1.4]
107439
107262
  */
107440
107263
  parentTable?: Word.Interfaces.TableLoadOptions;
107441
107264
  /**
107442
- * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it is not contained in a table cell.
107265
+ * 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.
107443
107266
  *
107444
107267
  * @remarks
107445
107268
  * [Api set: WordApi 1.4]
@@ -107602,7 +107425,7 @@ declare namespace Word {
107602
107425
  */
107603
107426
  superscript?: boolean;
107604
107427
  /**
107605
- * Specifies a value that indicates the font's underline type. 'None' if the font is not underlined.
107428
+ * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined.
107606
107429
  *
107607
107430
  * @remarks
107608
107431
  * [Api set: WordApi 1.1]
@@ -107642,14 +107465,14 @@ declare namespace Word {
107642
107465
  */
107643
107466
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
107644
107467
  /**
107645
- * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it is not contained in a table.
107468
+ * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table.
107646
107469
  *
107647
107470
  * @remarks
107648
107471
  * [Api set: WordApi 1.3]
107649
107472
  */
107650
107473
  parentTable?: Word.Interfaces.TableLoadOptions;
107651
107474
  /**
107652
- * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it is not contained in a table cell.
107475
+ * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell.
107653
107476
  *
107654
107477
  * @remarks
107655
107478
  * [Api set: WordApi 1.3]
@@ -107732,53 +107555,53 @@ declare namespace Word {
107732
107555
  */
107733
107556
  $all?: boolean;
107734
107557
  /**
107735
- * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image.
107736
- *
107737
- * @remarks
107738
- * [Api set: WordApi 1.2]
107739
- */
107558
+ * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image.
107559
+ *
107560
+ * @remarks
107561
+ * [Api set: WordApi 1.2]
107562
+ */
107740
107563
  paragraph?: Word.Interfaces.ParagraphLoadOptions;
107741
107564
  /**
107742
- * 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.
107743
- *
107744
- * @remarks
107745
- * [Api set: WordApi 1.1]
107746
- */
107565
+ * 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.
107566
+ *
107567
+ * @remarks
107568
+ * [Api set: WordApi 1.1]
107569
+ */
107747
107570
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
107748
107571
  /**
107749
- * 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}.
107750
- *
107751
- * @remarks
107752
- * [Api set: WordApi 1.3]
107753
- */
107572
+ * 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}.
107573
+ *
107574
+ * @remarks
107575
+ * [Api set: WordApi 1.3]
107576
+ */
107754
107577
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
107755
107578
  /**
107756
- * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it is not contained in a table.
107757
- *
107758
- * @remarks
107759
- * [Api set: WordApi 1.3]
107760
- */
107579
+ * 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.
107580
+ *
107581
+ * @remarks
107582
+ * [Api set: WordApi 1.3]
107583
+ */
107761
107584
  parentTable?: Word.Interfaces.TableLoadOptions;
107762
107585
  /**
107763
- * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it is not contained in a table cell.
107764
- *
107765
- * @remarks
107766
- * [Api set: WordApi 1.3]
107767
- */
107586
+ * 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.
107587
+ *
107588
+ * @remarks
107589
+ * [Api set: WordApi 1.3]
107590
+ */
107768
107591
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
107769
107592
  /**
107770
- * 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}.
107771
- *
107772
- * @remarks
107773
- * [Api set: WordApi 1.3]
107774
- */
107593
+ * 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}.
107594
+ *
107595
+ * @remarks
107596
+ * [Api set: WordApi 1.3]
107597
+ */
107775
107598
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
107776
107599
  /**
107777
- * 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}.
107778
- *
107779
- * @remarks
107780
- * [Api set: WordApi 1.3]
107781
- */
107600
+ * 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}.
107601
+ *
107602
+ * @remarks
107603
+ * [Api set: WordApi 1.3]
107604
+ */
107782
107605
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
107783
107606
  /**
107784
107607
  * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image.
@@ -108231,88 +108054,88 @@ declare namespace Word {
108231
108054
  */
108232
108055
  $all?: boolean;
108233
108056
  /**
108234
- * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
108235
- *
108236
- * @remarks
108237
- * [Api set: WordApi 1.1]
108238
- */
108057
+ * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
108058
+ *
108059
+ * @remarks
108060
+ * [Api set: WordApi 1.1]
108061
+ */
108239
108062
  font?: Word.Interfaces.FontLoadOptions;
108240
108063
  /**
108241
- * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph is not in a list.
108242
- *
108243
- * @remarks
108244
- * [Api set: WordApi 1.3]
108245
- */
108064
+ * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list.
108065
+ *
108066
+ * @remarks
108067
+ * [Api set: WordApi 1.3]
108068
+ */
108246
108069
  list?: Word.Interfaces.ListLoadOptions;
108247
108070
  /**
108248
- * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph is not part of a list.
108249
- *
108250
- * @remarks
108251
- * [Api set: WordApi 1.3]
108252
- */
108071
+ * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list.
108072
+ *
108073
+ * @remarks
108074
+ * [Api set: WordApi 1.3]
108075
+ */
108253
108076
  listItem?: Word.Interfaces.ListItemLoadOptions;
108254
108077
  /**
108255
- * 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}.
108256
- *
108257
- * @remarks
108258
- * [Api set: WordApi 1.3]
108259
- */
108078
+ * 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}.
108079
+ *
108080
+ * @remarks
108081
+ * [Api set: WordApi 1.3]
108082
+ */
108260
108083
  listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;
108261
108084
  /**
108262
- * 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}.
108263
- *
108264
- * @remarks
108265
- * [Api set: WordApi 1.3]
108266
- */
108085
+ * 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}.
108086
+ *
108087
+ * @remarks
108088
+ * [Api set: WordApi 1.3]
108089
+ */
108267
108090
  listOrNullObject?: Word.Interfaces.ListLoadOptions;
108268
108091
  /**
108269
- * Gets the parent body of the paragraph.
108270
- *
108271
- * @remarks
108272
- * [Api set: WordApi 1.3]
108273
- */
108092
+ * Gets the parent body of the paragraph.
108093
+ *
108094
+ * @remarks
108095
+ * [Api set: WordApi 1.3]
108096
+ */
108274
108097
  parentBody?: Word.Interfaces.BodyLoadOptions;
108275
108098
  /**
108276
- * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control.
108277
- *
108278
- * @remarks
108279
- * [Api set: WordApi 1.1]
108280
- */
108099
+ * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control.
108100
+ *
108101
+ * @remarks
108102
+ * [Api set: WordApi 1.1]
108103
+ */
108281
108104
  parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
108282
108105
  /**
108283
- * 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}.
108284
- *
108285
- * @remarks
108286
- * [Api set: WordApi 1.3]
108287
- */
108106
+ * 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}.
108107
+ *
108108
+ * @remarks
108109
+ * [Api set: WordApi 1.3]
108110
+ */
108288
108111
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
108289
108112
  /**
108290
- * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it is not contained in a table.
108291
- *
108292
- * @remarks
108293
- * [Api set: WordApi 1.3]
108294
- */
108113
+ * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table.
108114
+ *
108115
+ * @remarks
108116
+ * [Api set: WordApi 1.3]
108117
+ */
108295
108118
  parentTable?: Word.Interfaces.TableLoadOptions;
108296
108119
  /**
108297
- * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it is not contained in a table cell.
108298
- *
108299
- * @remarks
108300
- * [Api set: WordApi 1.3]
108301
- */
108120
+ * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell.
108121
+ *
108122
+ * @remarks
108123
+ * [Api set: WordApi 1.3]
108124
+ */
108302
108125
  parentTableCell?: Word.Interfaces.TableCellLoadOptions;
108303
108126
  /**
108304
- * 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}.
108305
- *
108306
- * @remarks
108307
- * [Api set: WordApi 1.3]
108308
- */
108127
+ * 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}.
108128
+ *
108129
+ * @remarks
108130
+ * [Api set: WordApi 1.3]
108131
+ */
108309
108132
  parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
108310
108133
  /**
108311
- * 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}.
108312
- *
108313
- * @remarks
108314
- * [Api set: WordApi 1.3]
108315
- */
108134
+ * 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}.
108135
+ *
108136
+ * @remarks
108137
+ * [Api set: WordApi 1.3]
108138
+ */
108316
108139
  parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
108317
108140
  /**
108318
108141
  * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
@@ -108413,7 +108236,7 @@ declare namespace Word {
108413
108236
  */
108414
108237
  styleBuiltIn?: boolean;
108415
108238
  /**
108416
- * Gets the level of the paragraph's table. It returns 0 if the paragraph is not in a table.
108239
+ * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
108417
108240
  *
108418
108241
  * @remarks
108419
108242
  * [Api set: WordApi 1.3]
@@ -108430,8 +108253,7 @@ declare namespace Word {
108430
108253
  * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
108431
108254
  *
108432
108255
  * @remarks
108433
- * [Api set: WordApi BETA (PREVIEW ONLY)]
108434
- * @beta
108256
+ * [Api set: WordApi 1.6]
108435
108257
  */
108436
108258
  uniqueLocalId?: boolean;
108437
108259
  }
@@ -108454,14 +108276,14 @@ declare namespace Word {
108454
108276
  */
108455
108277
  font?: Word.Interfaces.FontLoadOptions;
108456
108278
  /**
108457
- * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph is not in a list.
108279
+ * 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.
108458
108280
  *
108459
108281
  * @remarks
108460
108282
  * [Api set: WordApi 1.3]
108461
108283
  */
108462
108284
  list?: Word.Interfaces.ListLoadOptions;
108463
108285
  /**
108464
- * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph is not part of a list.
108286
+ * 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.
108465
108287
  *
108466
108288
  * @remarks
108467
108289
  * [Api set: WordApi 1.3]
@@ -108503,14 +108325,14 @@ declare namespace Word {
108503
108325
  */
108504
108326
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
108505
108327
  /**
108506
- * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it is not contained in a table.
108328
+ * 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.
108507
108329
  *
108508
108330
  * @remarks
108509
108331
  * [Api set: WordApi 1.3]
108510
108332
  */
108511
108333
  parentTable?: Word.Interfaces.TableLoadOptions;
108512
108334
  /**
108513
- * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it is not contained in a table cell.
108335
+ * 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.
108514
108336
  *
108515
108337
  * @remarks
108516
108338
  * [Api set: WordApi 1.3]
@@ -108629,7 +108451,7 @@ declare namespace Word {
108629
108451
  */
108630
108452
  styleBuiltIn?: boolean;
108631
108453
  /**
108632
- * For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph is not in a table.
108454
+ * For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
108633
108455
  *
108634
108456
  * @remarks
108635
108457
  * [Api set: WordApi 1.3]
@@ -108646,8 +108468,7 @@ declare namespace Word {
108646
108468
  * For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.
108647
108469
  *
108648
108470
  * @remarks
108649
- * [Api set: WordApi BETA (PREVIEW ONLY)]
108650
- * @beta
108471
+ * [Api set: WordApi 1.6]
108651
108472
  */
108652
108473
  uniqueLocalId?: boolean;
108653
108474
  }
@@ -108801,14 +108622,14 @@ declare namespace Word {
108801
108622
  */
108802
108623
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
108803
108624
  /**
108804
- * Gets the table that contains the range. Throws an `ItemNotFound` error if it is not contained in a table.
108625
+ * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table.
108805
108626
  *
108806
108627
  * @remarks
108807
108628
  * [Api set: WordApi 1.3]
108808
108629
  */
108809
108630
  parentTable?: Word.Interfaces.TableLoadOptions;
108810
108631
  /**
108811
- * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it is not contained in a table cell.
108632
+ * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell.
108812
108633
  *
108813
108634
  * @remarks
108814
108635
  * [Api set: WordApi 1.3]
@@ -108904,14 +108725,14 @@ declare namespace Word {
108904
108725
  */
108905
108726
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
108906
108727
  /**
108907
- * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it is not contained in a table.
108728
+ * 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.
108908
108729
  *
108909
108730
  * @remarks
108910
108731
  * [Api set: WordApi 1.3]
108911
108732
  */
108912
108733
  parentTable?: Word.Interfaces.TableLoadOptions;
108913
108734
  /**
108914
- * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it is not contained in a table cell.
108735
+ * 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.
108915
108736
  *
108916
108737
  * @remarks
108917
108738
  * [Api set: WordApi 1.3]
@@ -109041,11 +108862,11 @@ declare namespace Word {
109041
108862
  */
109042
108863
  $all?: boolean;
109043
108864
  /**
109044
- * Gets the body object of the section. This does not include the header/footer and other section metadata.
109045
- *
109046
- * @remarks
109047
- * [Api set: WordApi 1.1]
109048
- */
108865
+ * Gets the body object of the section. This doesn't include the header/footer and other section metadata.
108866
+ *
108867
+ * @remarks
108868
+ * [Api set: WordApi 1.1]
108869
+ */
109049
108870
  body?: Word.Interfaces.BodyLoadOptions;
109050
108871
  }
109051
108872
  /**
@@ -109060,10 +108881,10 @@ declare namespace Word {
109060
108881
  */
109061
108882
  $all?: boolean;
109062
108883
  /**
109063
- * For EACH ITEM in the collection: Gets the body object of the section. This does not include the header/footer and other section metadata.
109064
- *
109065
- * @remarks
109066
- * [Api set: WordApi 1.1]
108884
+ * For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata.
108885
+ *
108886
+ * @remarks
108887
+ * [Api set: WordApi 1.1]
109067
108888
  */
109068
108889
  body?: Word.Interfaces.BodyLoadOptions;
109069
108890
  }
@@ -109164,23 +108985,23 @@ declare namespace Word {
109164
108985
  * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
109165
108986
  *
109166
108987
  * @remarks
109167
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109168
- * @beta
108988
+ * [Api set: WordApi 1.6]
109169
108989
  */
109170
108990
  shading?: Word.Interfaces.ShadingLoadOptions;
109171
108991
  /**
109172
108992
  * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table.
109173
108993
  *
109174
108994
  * @remarks
109175
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109176
- * @beta
108995
+ * [Api set: WordApi 1.6]
109177
108996
  */
109178
108997
  tableStyle?: Word.Interfaces.TableStyleLoadOptions;
109179
108998
  /**
109180
- * For EACH ITEM in the collection: Gets the name of an existing style to use as the base formatting of another style.
108999
+ * For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style.
109181
109000
  *
109182
109001
  * @remarks
109183
109002
  * [Api set: WordApi 1.5]
109003
+ *
109004
+ * Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
109184
109005
  */
109185
109006
  baseStyle?: boolean;
109186
109007
  /**
@@ -109220,10 +109041,12 @@ declare namespace Word {
109220
109041
  */
109221
109042
  nameLocal?: boolean;
109222
109043
  /**
109223
- * For EACH ITEM in the collection: Gets the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.
109044
+ * 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.
109224
109045
  *
109225
109046
  * @remarks
109226
109047
  * [Api set: WordApi 1.5]
109048
+ *
109049
+ * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
109227
109050
  */
109228
109051
  nextParagraphStyle?: boolean;
109229
109052
  /**
@@ -109307,23 +109130,23 @@ declare namespace Word {
109307
109130
  * Gets a Shading object that represents the shading for the specified style. Not applicable to List style.
109308
109131
  *
109309
109132
  * @remarks
109310
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109311
- * @beta
109133
+ * [Api set: WordApi 1.6]
109312
109134
  */
109313
109135
  shading?: Word.Interfaces.ShadingLoadOptions;
109314
109136
  /**
109315
109137
  * Gets a TableStyle object representing Style properties that can be applied to a table.
109316
109138
  *
109317
109139
  * @remarks
109318
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109319
- * @beta
109140
+ * [Api set: WordApi 1.6]
109320
109141
  */
109321
109142
  tableStyle?: Word.Interfaces.TableStyleLoadOptions;
109322
109143
  /**
109323
- * Gets the name of an existing style to use as the base formatting of another style.
109144
+ * Specifies the name of an existing style to use as the base formatting of another style.
109324
109145
  *
109325
109146
  * @remarks
109326
109147
  * [Api set: WordApi 1.5]
109148
+ *
109149
+ * Note: The ability to set `baseStyle` was introduced in WordApi 1.6.
109327
109150
  */
109328
109151
  baseStyle?: boolean;
109329
109152
  /**
@@ -109363,10 +109186,12 @@ declare namespace Word {
109363
109186
  */
109364
109187
  nameLocal?: boolean;
109365
109188
  /**
109366
- * Gets the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.
109189
+ * 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.
109367
109190
  *
109368
109191
  * @remarks
109369
109192
  * [Api set: WordApi 1.5]
109193
+ *
109194
+ * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6.
109370
109195
  */
109371
109196
  nextParagraphStyle?: boolean;
109372
109197
  /**
@@ -109409,8 +109234,7 @@ declare namespace Word {
109409
109234
  * Represents the shading object.
109410
109235
  *
109411
109236
  * @remarks
109412
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109413
- * @beta
109237
+ * [Api set: WordApi 1.6]
109414
109238
  */
109415
109239
  interface ShadingLoadOptions {
109416
109240
  /**
@@ -109421,8 +109245,7 @@ declare namespace Word {
109421
109245
  * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
109422
109246
  *
109423
109247
  * @remarks
109424
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109425
- * @beta
109248
+ * [Api set: WordApi 1.6]
109426
109249
  */
109427
109250
  backgroundPatternColor?: boolean;
109428
109251
  /**
@@ -109434,7 +109257,7 @@ declare namespace Word {
109434
109257
  */
109435
109258
  foregroundPatternColor?: boolean;
109436
109259
  /**
109437
- * Specifies the shading texture of the object.
109260
+ * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}.
109438
109261
  *
109439
109262
  * @remarks
109440
109263
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -109482,14 +109305,14 @@ declare namespace Word {
109482
109305
  */
109483
109306
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
109484
109307
  /**
109485
- * Gets the table that contains this table. Throws an `ItemNotFound` error if it is not contained in a table.
109308
+ * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table.
109486
109309
  *
109487
109310
  * @remarks
109488
109311
  * [Api set: WordApi 1.3]
109489
109312
  */
109490
109313
  parentTable?: Word.Interfaces.TableLoadOptions;
109491
109314
  /**
109492
- * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it is not contained in a table cell.
109315
+ * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell.
109493
109316
  *
109494
109317
  * @remarks
109495
109318
  * [Api set: WordApi 1.3]
@@ -109633,8 +109456,7 @@ declare namespace Word {
109633
109456
  * Represents the TableStyle object.
109634
109457
  *
109635
109458
  * @remarks
109636
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109637
- * @beta
109459
+ * [Api set: WordApi 1.6]
109638
109460
  */
109639
109461
  interface TableStyleLoadOptions {
109640
109462
  /**
@@ -109661,40 +109483,35 @@ declare namespace Word {
109661
109483
  * Specifies the amount of space to add between the contents and the bottom borders of the cells.
109662
109484
  *
109663
109485
  * @remarks
109664
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109665
- * @beta
109486
+ * [Api set: WordApi 1.6]
109666
109487
  */
109667
109488
  bottomCellMargin?: boolean;
109668
109489
  /**
109669
109490
  * Specifies the spacing (in points) between the cells in a table style.
109670
109491
  *
109671
109492
  * @remarks
109672
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109673
- * @beta
109493
+ * [Api set: WordApi 1.6]
109674
109494
  */
109675
109495
  cellSpacing?: boolean;
109676
109496
  /**
109677
109497
  * Specifies the amount of space to add between the contents and the left borders of the cells.
109678
109498
  *
109679
109499
  * @remarks
109680
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109681
- * @beta
109500
+ * [Api set: WordApi 1.6]
109682
109501
  */
109683
109502
  leftCellMargin?: boolean;
109684
109503
  /**
109685
109504
  * Specifies the amount of space to add between the contents and the right borders of the cells.
109686
109505
  *
109687
109506
  * @remarks
109688
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109689
- * @beta
109507
+ * [Api set: WordApi 1.6]
109690
109508
  */
109691
109509
  rightCellMargin?: boolean;
109692
109510
  /**
109693
109511
  * Specifies the amount of space to add between the contents and the top borders of the cells.
109694
109512
  *
109695
109513
  * @remarks
109696
- * [Api set: WordApi BETA (PREVIEW ONLY)]
109697
- * @beta
109514
+ * [Api set: WordApi 1.6]
109698
109515
  */
109699
109516
  topCellMargin?: boolean;
109700
109517
  }
@@ -109738,14 +109555,14 @@ declare namespace Word {
109738
109555
  */
109739
109556
  parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
109740
109557
  /**
109741
- * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it is not contained in a table.
109558
+ * 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.
109742
109559
  *
109743
109560
  * @remarks
109744
109561
  * [Api set: WordApi 1.3]
109745
109562
  */
109746
109563
  parentTable?: Word.Interfaces.TableLoadOptions;
109747
109564
  /**
109748
- * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it is not contained in a table cell.
109565
+ * 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.
109749
109566
  *
109750
109567
  * @remarks
109751
109568
  * [Api set: WordApi 1.3]
@@ -110264,8 +110081,7 @@ declare namespace Word {
110264
110081
  * Represents a tracked change in a Word document.
110265
110082
  *
110266
110083
  * @remarks
110267
- * [Api set: WordApi BETA (PREVIEW ONLY)]
110268
- * @beta
110084
+ * [Api set: WordApi 1.6]
110269
110085
  */
110270
110086
  interface TrackedChangeLoadOptions {
110271
110087
  /**
@@ -110273,35 +110089,31 @@ declare namespace Word {
110273
110089
  */
110274
110090
  $all?: boolean;
110275
110091
  /**
110276
- * Specifies the author of the tracked change.
110092
+ * Gets the author of the tracked change.
110277
110093
  *
110278
110094
  * @remarks
110279
- * [Api set: WordApi BETA (PREVIEW ONLY)]
110280
- * @beta
110095
+ * [Api set: WordApi 1.6]
110281
110096
  */
110282
110097
  author?: boolean;
110283
110098
  /**
110284
- * Specifies the date of the tracked change.
110099
+ * Gets the date of the tracked change.
110285
110100
  *
110286
110101
  * @remarks
110287
- * [Api set: WordApi BETA (PREVIEW ONLY)]
110288
- * @beta
110102
+ * [Api set: WordApi 1.6]
110289
110103
  */
110290
110104
  date?: boolean;
110291
110105
  /**
110292
- * Specifies the text of the tracked change.
110106
+ * Gets the text of the tracked change.
110293
110107
  *
110294
110108
  * @remarks
110295
- * [Api set: WordApi BETA (PREVIEW ONLY)]
110296
- * @beta
110109
+ * [Api set: WordApi 1.6]
110297
110110
  */
110298
110111
  text?: boolean;
110299
110112
  /**
110300
- * Specifies the type of the tracked change.
110113
+ * Gets the type of the tracked change.
110301
110114
  *
110302
110115
  * @remarks
110303
- * [Api set: WordApi BETA (PREVIEW ONLY)]
110304
- * @beta
110116
+ * [Api set: WordApi 1.6]
110305
110117
  */
110306
110118
  type?: boolean;
110307
110119
  }
@@ -110309,8 +110121,7 @@ declare namespace Word {
110309
110121
  * Contains a collection of {@link Word.TrackedChange} objects.
110310
110122
  *
110311
110123
  * @remarks
110312
- * [Api set: WordApi BETA (PREVIEW ONLY)]
110313
- * @beta
110124
+ * [Api set: WordApi 1.6]
110314
110125
  */
110315
110126
  interface TrackedChangeCollectionLoadOptions {
110316
110127
  /**
@@ -110318,35 +110129,31 @@ declare namespace Word {
110318
110129
  */
110319
110130
  $all?: boolean;
110320
110131
  /**
110321
- * For EACH ITEM in the collection: Specifies the author of the tracked change.
110132
+ * For EACH ITEM in the collection: Gets the author of the tracked change.
110322
110133
  *
110323
110134
  * @remarks
110324
- * [Api set: WordApi BETA (PREVIEW ONLY)]
110325
- * @beta
110135
+ * [Api set: WordApi 1.6]
110326
110136
  */
110327
110137
  author?: boolean;
110328
110138
  /**
110329
- * For EACH ITEM in the collection: Specifies the date of the tracked change.
110139
+ * For EACH ITEM in the collection: Gets the date of the tracked change.
110330
110140
  *
110331
110141
  * @remarks
110332
- * [Api set: WordApi BETA (PREVIEW ONLY)]
110333
- * @beta
110142
+ * [Api set: WordApi 1.6]
110334
110143
  */
110335
110144
  date?: boolean;
110336
110145
  /**
110337
- * For EACH ITEM in the collection: Specifies the text of the tracked change.
110146
+ * For EACH ITEM in the collection: Gets the text of the tracked change.
110338
110147
  *
110339
110148
  * @remarks
110340
- * [Api set: WordApi BETA (PREVIEW ONLY)]
110341
- * @beta
110149
+ * [Api set: WordApi 1.6]
110342
110150
  */
110343
110151
  text?: boolean;
110344
110152
  /**
110345
- * For EACH ITEM in the collection: Specifies the type of the tracked change.
110153
+ * For EACH ITEM in the collection: Gets the type of the tracked change.
110346
110154
  *
110347
110155
  * @remarks
110348
- * [Api set: WordApi BETA (PREVIEW ONLY)]
110349
- * @beta
110156
+ * [Api set: WordApi 1.6]
110350
110157
  */
110351
110158
  type?: boolean;
110352
110159
  }